Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / system / libbase / 9cc7edc0c80490e867e28b435cb77d953fee90fb
commit9cc7edc0c80490e867e28b435cb77d953fee90fb[log] [tgz]
authorBernie Innocenti <codewiz@google.com>Thu Feb 06 02:51:42 2020 +0900
committerBernie Innocenti <codewiz@google.com>Thu Feb 06 15:27:26 2020 +0900
treecd1631624a481d3d2d264f6affea90fa5c5394a2
parent64463d73d617f1f8ed312cce0afae8026e718808 [diff]
Add macros to check for successful Result

These macros are meant to be used in tests:

  Result<File> maybe_a_file = OpenFile(...);
  EXPECT_OK(maybe_a_file);

On failure, the error is printed.

There's no equivalent EXPECT_NOT_OK() because it is a testing anti-pattern
which causes tests to pass even when the error changed as a result of a
regression. Use EPECT_EQ(result, Error(...)) instead.

Test: cd system/core && atest
Test: m
Change-Id: Ie26f90d3c62620e7b1f10013829ba43ef5364fe1
1 file changed
tree: cd1631624a481d3d2d264f6affea90fa5c5394a2
  1. include/
  2. .clang-format ⇨ ../.clang-format-2
  3. abi_compatibility.cpp
  4. Android.bp
  5. chrono_utils.cpp
  6. chrono_utils_test.cpp
  7. cmsg.cpp
  8. cmsg_test.cpp
  9. CPPLINT.cfg
  10. endian_test.cpp
  11. errors_test.cpp
  12. errors_unix.cpp
  13. errors_windows.cpp
  14. expected_test.cpp
  15. file.cpp
  16. file_test.cpp
  17. format_benchmark.cpp
  18. liblog_symbols.cpp
  19. liblog_symbols.h
  20. logging.cpp
  21. logging_test.cpp
  22. macros_test.cpp
  23. mapped_file.cpp
  24. mapped_file_test.cpp
  25. no_destructor_test.cpp
  26. OWNERS
  27. parsebool.cpp
  28. parsebool_test.cpp
  29. parsedouble_test.cpp
  30. parseint_test.cpp
  31. parsenetaddress.cpp
  32. parsenetaddress_test.cpp
  33. process.cpp
  34. process_test.cpp
  35. properties.cpp
  36. properties_test.cpp
  37. README.md
  38. result_test.cpp
  39. scopeguard_test.cpp
  40. stringprintf.cpp
  41. stringprintf_test.cpp
  42. strings.cpp
  43. strings_test.cpp
  44. test_main.cpp
  45. test_utils.cpp
  46. test_utils_test.cpp
  47. threads.cpp
  48. utf8.cpp
  49. utf8_test.cpp
README.md

libbase

Who is this library for?

This library is a collection of convenience functions to make common tasks easier and less error-prone.

In this context, "error-prone" covers both "hard to do correctly" and "hard to do with good performance", but as a general purpose library, libbase's primary focus is on making it easier to do things easily and correctly when a compromise has to be made between "simplest API" on the one hand and "fastest implementation" on the other. Though obviously the ideal is to have both.

Should my routine be added?

The intention is to cover the 80% use cases, not be all things to all users.

If you have a routine that's really useful in your project, congratulations. But that doesn't mean it should be here rather than just in your project.

The question for libbase is "should everyone be doing this?"/"does this make everyone's code cleaner/safer?". Historically we've considered the bar for inclusion to be "are there at least three unrelated projects that would be cleaned up by doing so".

If your routine is actually something from a future C++ standard (that isn't yet in libc++), or it's widely used in another library, that helps show that there's precedent. Being able to say "so-and-so has used this API for n years" is a good way to reduce concerns about API choices.

Any other restrictions?

Unlike most Android code, code in libbase has to build for Mac and Windows too.

Code here is also expected to have good test coverage.

By its nature, it's difficult to change libbase API. It's often best to start using your routine just in your project, and let it "graduate" after you're certain that the API is solid.