diff options
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/skylarkbuildapi/test/TestingModuleApi.java')
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/skylarkbuildapi/test/TestingModuleApi.java | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/test/TestingModuleApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/test/TestingModuleApi.java new file mode 100644 index 0000000000..63528c9b56 --- /dev/null +++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/test/TestingModuleApi.java @@ -0,0 +1,72 @@ +// Copyright 2018 The Bazel Authors. All rights reserved. +// +// 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. + +package com.google.devtools.build.lib.skylarkbuildapi.test; + +import com.google.devtools.build.lib.skylarkinterface.Param; +import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; +import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; +import com.google.devtools.build.lib.syntax.SkylarkDict; + +/** + * Helper module for accessing test infrastructure. + */ +@SkylarkModule( + name = "testing", + doc = "Helper methods for skylark to access testing infrastructure." +) +public interface TestingModuleApi { + + // TODO(bazel-team): Change this function to be the actual ExecutionInfo.PROVIDER. + @SkylarkCallable( + name = "ExecutionInfo", + doc = + "Creates a new execution info provider. Use this provider to specify special" + + "environments requirements needed to run tests.", + parameters = { + @Param( + name = "requirements", + type = SkylarkDict.class, + named = false, + positional = true, + doc = + "A map of string keys and values to indicate special execution requirements," + + " such as hardware platforms, etc. These keys and values are passed to the" + + " executor of the test action as parameters to configure the execution" + + " environment." + ) + } + ) + public ExecutionInfoApi executionInfo(SkylarkDict<String, String> requirements); + + // TODO(bazel-team): Change this function to be the actual TestEnvironmentInfo.PROVIDER. + @SkylarkCallable( + name = "TestEnvironment", + doc = + "Creates a new test environment provider. Use this provider to specify extra" + + "environment variables to be made available during test execution.", + parameters = { + @Param( + name = "environment", + type = SkylarkDict.class, + named = false, + positional = true, + doc = + "A map of string keys and values that represent environment variables and their" + + " values. These will be made available during the test execution." + ) + } + ) + public TestEnvironmentInfoApi testEnvironment(SkylarkDict<String, String> environment); +} |