This is an automated email from the ASF dual-hosted git repository. not-in-ldap pushed a commit to branch tristan/variables-refactor in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit 814a3e8d17433be602a99e32fdfa1ca122edf6d6 Author: Tristan van Berkom <[email protected]> AuthorDate: Sun Jun 28 23:59:42 2020 +0900 tests/format/variables.py: Added some new tests * Test scenarios where a junction needs to resolve variables in order to configure a subproject, but where some other variables may be derived from the same subproject. In this scenario we allow partial resolution of variables for junction elements. * Enhanced the undefined variables and circular reference tests to also check for the expected provenances. --- tests/format/variables.py | 59 ++++++++++++++++------ tests/format/variables/cyclic_variables/cyclic.bst | 2 +- .../variables/cyclic_variables/indirect-cyclic.bst | 8 +++ .../variables/cyclic_variables/self-reference.bst | 4 ++ .../format/variables/missing_variables/manual3.bst | 10 ++++ 5 files changed, 67 insertions(+), 16 deletions(-) diff --git a/tests/format/variables.py b/tests/format/variables.py index 5fad104..7074732 100644 --- a/tests/format/variables.py +++ b/tests/format/variables.py @@ -53,30 +53,59 @@ def test_overrides(cli, datafiles, target, varname, expected): assert result_vars.get_str(varname) == expected [email protected]("element", ["manual.bst", "manual2.bst"]) [email protected]( + "element,provenance", + [ + # This test makes a reference to an undefined variable in a build command + ("manual.bst", "manual.bst [line 5 column 6]"), + # This test makes a reference to an undefined variable by another variable, + # ensuring that we validate variables even when they are unused + ("manual2.bst", "manual2.bst [line 4 column 8]"), + # This test uses a build command to refer to some variables which ultimately + # refer to an undefined variable, testing a more complex case. + ("manual3.bst", "manual3.bst [line 6 column 8]"), + ], + ids=["build-command", "variables", "complex"], +) @pytest.mark.datafiles(os.path.join(DATA_DIR, "missing_variables")) -def test_missing_variable(cli, datafiles, element): +def test_undefined(cli, datafiles, element, provenance): project = str(datafiles) result = cli.run(project=project, silent=True, args=["show", "--deps", "none", "--format", "%{config}", element]) result.assert_main_error(ErrorDomain.LOAD, LoadErrorReason.UNRESOLVED_VARIABLE) + assert provenance in result.stderr [email protected]( + "element,provenances", + [ + # Test a simple a -> b and b -> a reference + ("simple-cyclic.bst", ["simple-cyclic.bst [line 4 column 5]", "simple-cyclic.bst [line 5 column 5]"]), + # Test a simple a -> b and b -> a reference with some text involved + ("cyclic.bst", ["cyclic.bst [line 5 column 10]", "cyclic.bst [line 4 column 5]"]), + # Test an indirect circular dependency + ( + "indirect-cyclic.bst", + [ + "indirect-cyclic.bst [line 5 column 5]", + "indirect-cyclic.bst [line 6 column 5]", + "indirect-cyclic.bst [line 7 column 5]", + "indirect-cyclic.bst [line 8 column 5]", + ], + ), + # Test an indirect circular dependency + ("self-reference.bst", ["self-reference.bst [line 4 column 5]"]), + ], + ids=["simple", "simple-text", "indirect", "self-reference"], +) @pytest.mark.timeout(15, method="signal") @pytest.mark.datafiles(os.path.join(DATA_DIR, "cyclic_variables")) -def test_simple_cyclic_variables(cli, datafiles): - print_warning("Performing cyclic test, if this test times out it will " + "exit the test sequence") - project = str(datafiles) - result = cli.run(project=project, silent=True, args=["build", "simple-cyclic.bst"]) - result.assert_main_error(ErrorDomain.LOAD, LoadErrorReason.UNRESOLVED_VARIABLE) - - [email protected](15, method="signal") [email protected](os.path.join(DATA_DIR, "cyclic_variables")) -def test_cyclic_variables(cli, datafiles): - print_warning("Performing cyclic test, if this test times out it will " + "exit the test sequence") +def test_circular_reference(cli, datafiles, element, provenances): + print_warning("Performing cyclic test, if this test times out it will exit the test sequence") project = str(datafiles) - result = cli.run(project=project, silent=True, args=["build", "cyclic.bst"]) - result.assert_main_error(ErrorDomain.LOAD, LoadErrorReason.UNRESOLVED_VARIABLE) + result = cli.run(project=project, silent=True, args=["build", element]) + result.assert_main_error(ErrorDomain.LOAD, LoadErrorReason.CIRCULAR_REFERENCE_VARIABLE) + for provenance in provenances: + assert provenance in result.stderr @pytest.mark.parametrize("protected_var", PROTECTED_VARIABLES) diff --git a/tests/format/variables/cyclic_variables/cyclic.bst b/tests/format/variables/cyclic_variables/cyclic.bst index a05a40b..38832fa 100644 --- a/tests/format/variables/cyclic_variables/cyclic.bst +++ b/tests/format/variables/cyclic_variables/cyclic.bst @@ -2,4 +2,4 @@ kind: manual variables: a: "%{prefix}/a" - prefix: "%{a}/some_prefix/" \ No newline at end of file + prefix: "%{a}/some_prefix/" diff --git a/tests/format/variables/cyclic_variables/indirect-cyclic.bst b/tests/format/variables/cyclic_variables/indirect-cyclic.bst new file mode 100644 index 0000000..fb06fb0 --- /dev/null +++ b/tests/format/variables/cyclic_variables/indirect-cyclic.bst @@ -0,0 +1,8 @@ +kind: manual + +variables: + foo: "%{a}" + a: "%{b}" + b: "%{c}" + c: "%{d}" + d: "%{a}" diff --git a/tests/format/variables/cyclic_variables/self-reference.bst b/tests/format/variables/cyclic_variables/self-reference.bst new file mode 100644 index 0000000..2e9829d --- /dev/null +++ b/tests/format/variables/cyclic_variables/self-reference.bst @@ -0,0 +1,4 @@ +kind: manual + +variables: + a: "Referencing itself with %{a}" diff --git a/tests/format/variables/missing_variables/manual3.bst b/tests/format/variables/missing_variables/manual3.bst new file mode 100644 index 0000000..ff3c8d5 --- /dev/null +++ b/tests/format/variables/missing_variables/manual3.bst @@ -0,0 +1,10 @@ +kind: manual + +variables: + hello: "Hello mister %{pony}" + greeting: "The %{hello} string twice: %{hello} again" + pony: "The pony is %{undefined}" + +config: + build-commands: + - Some indirectly undefined variable %{greeting}
