diff options
author | allevato <allevato@google.com> | 2017-07-07 21:40:50 +0200 |
---|---|---|
committer | László Csomor <laszlocsomor@google.com> | 2017-07-10 09:16:35 +0200 |
commit | 45b79e51575d93d4c1da93e070b159842a73b56a (patch) | |
tree | 1f4a0184910de731e46786f85a580e92628d999c /src/test/java/com/google/devtools | |
parent | 8ff3d2d61d1638553ef1315ca0f52a8357feca2f (diff) |
Add doc argument to attr.*, rule, aspect, and provider.
Skydoc can use these arguments to obtain documentation instead of (or in
addition to) Python-style docstrings.
RELNOTES: None.
PiperOrigin-RevId: 161233014
Diffstat (limited to 'src/test/java/com/google/devtools')
-rw-r--r-- | src/test/java/com/google/devtools/build/lib/skylark/SkylarkRuleClassFunctionsTest.java | 74 |
1 files changed, 71 insertions, 3 deletions
diff --git a/src/test/java/com/google/devtools/build/lib/skylark/SkylarkRuleClassFunctionsTest.java b/src/test/java/com/google/devtools/build/lib/skylark/SkylarkRuleClassFunctionsTest.java index a0f6316c9b..b3d614816d 100644 --- a/src/test/java/com/google/devtools/build/lib/skylark/SkylarkRuleClassFunctionsTest.java +++ b/src/test/java/com/google/devtools/build/lib/skylark/SkylarkRuleClassFunctionsTest.java @@ -493,7 +493,7 @@ public class SkylarkRuleClassFunctionsTest extends SkylarkTestCase { public void testAttrDefaultValueBadType() throws Exception { checkErrorContains( "argument 'default' has type 'int', but should be 'string'\n" - + "in call to builtin function attr.string(*, default, mandatory, values)", + + "in call to builtin function attr.string(*, default, doc, mandatory, values)", "attr.string(default = 1)"); } @@ -559,6 +559,34 @@ public class SkylarkRuleClassFunctionsTest extends SkylarkTestCase { } @Test + public void testAttrDoc() throws Exception { + // We don't actually store the doc in the attr definition; right now it's just meant to be + // extracted by documentation generating tools. So we don't have anything to assert and we just + // verify that no exceptions were thrown from building them. + buildAttribute("a1", "attr.bool(doc='foo')"); + buildAttribute("a2", "attr.int(doc='foo')"); + buildAttribute("a3", "attr.int_list(doc='foo')"); + buildAttribute("a4", "attr.label(doc='foo')"); + buildAttribute("a5", "attr.label_keyed_string_dict(doc='foo')"); + buildAttribute("a6", "attr.label_list(doc='foo')"); + buildAttribute("a7", "attr.license(doc='foo')"); + buildAttribute("a8", "attr.output(doc='foo')"); + buildAttribute("a9", "attr.output_list(doc='foo')"); + buildAttribute("a10", "attr.string(doc='foo')"); + buildAttribute("a11", "attr.string_dict(doc='foo')"); + buildAttribute("a12", "attr.string_list(doc='foo')"); + buildAttribute("a13", "attr.string_list_dict(doc='foo')"); + } + + @Test + public void testAttrDocValueBadType() throws Exception { + checkErrorContains( + "argument 'doc' has type 'int', but should be 'string'\n" + + "in call to builtin function attr.string(*, default, doc, mandatory, values)", + "attr.string(doc = 1)"); + } + + @Test public void testRuleImplementation() throws Exception { evalAndExport("def impl(ctx): return None", "rule1 = rule(impl)"); RuleClass c = ((RuleFunction) lookup("rule1")).getRuleClass(); @@ -566,10 +594,15 @@ public class SkylarkRuleClassFunctionsTest extends SkylarkTestCase { } @Test + public void testRuleDoc() throws Exception { + evalAndExport("def impl(ctx): return None", "rule1 = rule(impl, doc='foo')"); + } + + @Test public void testLateBoundAttrWorksWithOnlyLabel() throws Exception { checkEvalError( "argument 'default' has type 'function', but should be 'string'\n" - + "in call to builtin function attr.string(*, default, mandatory, values)", + + "in call to builtin function attr.string(*, default, doc, mandatory, values)", "def attr_value(cfg): return 'a'", "attr.string(default=attr_value)"); } @@ -689,6 +722,14 @@ public class SkylarkRuleClassFunctionsTest extends SkylarkTestCase { } @Test + public void testRuleBadTypeForDoc() throws Exception { + registerDummyUserDefinedFunction(); + checkErrorContains( + "argument 'doc' has type 'int', but should be 'string'", + "rule(impl, doc = 1)"); + } + + @Test public void testLabel() throws Exception { Object result = evalRuleClassCode("Label('//foo/foo:foo')"); assertThat(result).isInstanceOf(Label.class); @@ -1209,7 +1250,6 @@ public class SkylarkRuleClassFunctionsTest extends SkylarkTestCase { } @Test - public void structsAsDeclaredProvidersTest() throws Exception { evalAndExport( "data = struct(x = 1)" @@ -1222,6 +1262,18 @@ public class SkylarkRuleClassFunctionsTest extends SkylarkTestCase { } @Test + public void declaredProvidersDoc() throws Exception { + evalAndExport("data1 = provider(doc='foo')"); + } + + @Test + public void declaredProvidersBadTypeForDoc() throws Exception { + checkErrorContains( + "argument 'doc' has type 'int', but should be 'string'", + "provider(doc = 1)"); + } + + @Test public void aspectAllAttrs() throws Exception { evalAndExport( "def _impl(target, ctx):", @@ -1348,6 +1400,22 @@ public class SkylarkRuleClassFunctionsTest extends SkylarkTestCase { + " Should be list of providers, but got int. "); } + @Test + public void aspectDoc() throws Exception { + evalAndExport( + "def _impl(target, ctx):", + " pass", + "my_aspect = aspect(_impl, doc='foo')"); + } + + @Test + public void aspectBadTypeForDoc() throws Exception { + registerDummyUserDefinedFunction(); + checkErrorContains( + "argument 'doc' has type 'int', but should be 'string'", + "aspect(impl, doc = 1)"); + } + @Test |