mirror of
https://github.com/google/sandboxed-api.git
synced 2024-03-22 13:11:30 +08:00
dbaf95c724
This change should make it less confusing where utility code comes from. Having it in two places made sense when we were debating whether to publish Sandbox2 separately, but not any longer. Follow-up changes will move `sandbox2/util.h` and rename the remaining `sandbox2/util` folder. PiperOrigin-RevId: 351601640 Change-Id: I6256845261f610e590c25e2c59851cc51da2d778
70 lines
2.6 KiB
C++
70 lines
2.6 KiB
C++
// Copyright 2019 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef SANDBOXED_API_TESTING_H_
|
|
#define SANDBOXED_API_TESTING_H_
|
|
|
|
#include <cstdlib>
|
|
#include <string>
|
|
|
|
#include "absl/strings/string_view.h"
|
|
|
|
// The macro SKIP_SANITIZERS_AND_COVERAGE can be used in tests to skip running
|
|
// a given test (by emitting 'return') when running under one of the sanitizers
|
|
// (ASan, MSan, TSan) or under code coverage. Example:
|
|
//
|
|
// TEST(Foo, Bar) {
|
|
// SKIP_SANITIZERS_AND_COVERAGE;
|
|
// [...]
|
|
// }
|
|
//
|
|
// The reason for this is because Bazel options are inherited to binaries in
|
|
// data dependencies and cannot be per-target, which means when running a test
|
|
// with a sanitizer or coverage, the sandboxee as data dependency will also be
|
|
// compiled with sanitizer or coverage, which creates a lot of side effects and
|
|
// violates the sandbox policy prepared for the test.
|
|
// See b/7981124. // google3-only(internal reference)
|
|
// In other words, those tests cannot work under sanitizers or coverage, so we
|
|
// skip them in such situation using this macro.
|
|
//
|
|
// The downside of this approach is that no coverage will be collected.
|
|
// To still have coverage, pre-compile sandboxees and add them as test data,
|
|
// then no need to skip tests.
|
|
#if defined(ADDRESS_SANITIZER) || defined(MEMORY_SANITIZER) || \
|
|
defined(THREAD_SANITIZER)
|
|
#define SKIP_SANITIZERS_AND_COVERAGE return
|
|
#else
|
|
#define SKIP_SANITIZERS_AND_COVERAGE \
|
|
do { \
|
|
if (getenv("COVERAGE") != nullptr) { \
|
|
return; \
|
|
} \
|
|
} while (0)
|
|
#endif
|
|
|
|
namespace sapi {
|
|
|
|
// Returns a writable path usable in tests. If the name argument is specified,
|
|
// returns a name under that path. This can then be used for creating temporary
|
|
// test files and/or directories.
|
|
std::string GetTestTempPath(absl::string_view name = {});
|
|
|
|
// Returns a filename relative to the sandboxed_api directory at the root of the
|
|
// source tree. Use this to access data files in tests.
|
|
std::string GetTestSourcePath(absl::string_view name);
|
|
|
|
} // namespace sapi
|
|
|
|
#endif // SANDBOXED_API_TESTING_H_
|