From 7b1c47711dd0bcf61be829ccbf9e8cfdf9dd98d9 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Tue, 1 Mar 2016 16:54:04 +0100 Subject: Complete support of Yaml Axis Plugin The plugin uses a different matrix execution strategy. I have refactored the part of code assuming there is only one strategy. The previous one is known as 'default' and this change is back compatible. Drop an error whenever more than one strategy is used. Support exclude rules from either a file or inlined YAML (note in the later case the YAML will need to be a literal string). Tweak axis type documentation to reference both built-in axes and ones provided by additional plugins. Include three different examples for Yaml Axis which would help end users understand how to add support for exclusion and or specificy the exclusion as inlined Yaml. Change-Id: I18e0fc7cb525fba3b772bae10e81d8dfce7298cb --- jenkins_jobs/modules/project_matrix.py | 124 ++++++++++++++++----- .../fixtures/matrix-axis-yaml-strategy-file.xml | 29 +++++ .../fixtures/matrix-axis-yaml-strategy-file.yaml | 14 +++ .../fixtures/matrix-axis-yaml-strategy-inlined.xml | 34 ++++++ .../matrix-axis-yaml-strategy-inlined.yaml | 19 ++++ 5 files changed, 193 insertions(+), 27 deletions(-) create mode 100644 tests/general/fixtures/matrix-axis-yaml-strategy-file.xml create mode 100644 tests/general/fixtures/matrix-axis-yaml-strategy-file.yaml create mode 100644 tests/general/fixtures/matrix-axis-yaml-strategy-inlined.xml create mode 100644 tests/general/fixtures/matrix-axis-yaml-strategy-inlined.yaml diff --git a/jenkins_jobs/modules/project_matrix.py b/jenkins_jobs/modules/project_matrix.py index cd252b62..06b41066 100644 --- a/jenkins_jobs/modules/project_matrix.py +++ b/jenkins_jobs/modules/project_matrix.py @@ -42,17 +42,35 @@ On a matrix project, this will tie *only* the parent job. To restrict axes jobs, you can define a single value ``slave`` axis. :Job Parameters: - * **execution-strategy** (optional): + + .. note:: + + You can only pick one of the strategies. + + * **execution-strategy** (optional, built in Jenkins): * **combination-filter** (`str`): axes selection filter * **sequential** (`bool`): run builds sequentially (default false) * **touchstone** (optional): * **expr** (`str`) -- selection filter for the touchstone build * **result** (`str`) -- required result of the job: \ stable (default) or unstable + + * **yaml-strategy** (optional, requires + :jenkins-wiki:`Yaml Axis Plugin `): + + * **exclude-key** (`str`) -- top key containing exclusion rules + * Either one of: + * **filename** (`str`) -- Yaml file containing exclusions + * **text** (`str`) -- Inlined Yaml. Should be literal + ``text: | exclude:...`` + * **axes** (`list`): * **axis**: - * **type** (`str`) -- axis type, must be either - 'label-expression', 'user-defined', 'slave' or 'jdk'. + * **type** (`str`) -- axis type, must be either type defined by + :jenkins-wiki:`Matrix Project Plugin ` + (``label-expression``, ``user-defined``, ``slave`` or ``jdk``) or + a type defined by a plugin (see top of this document for a list + of supported plugins). * **name** (`str`) -- name of the axis * **values** (`list`) -- values of the axis @@ -69,10 +87,18 @@ Example: .. literalinclude:: /../../tests/yamlparser/fixtures/project-matrix001.yaml :language: yaml -Example for yaml axis: +Examples for yaml axis: .. literalinclude:: /../../tests/general/fixtures/matrix-axis-yaml.yaml :language: yaml + + .. literalinclude:: + /../../tests/general/fixtures/matrix-axis-yaml-strategy-file.yaml + :language: yaml + + .. literalinclude:: + /../../tests/general/fixtures/matrix-axis-yaml-strategy-inlined.yaml + :language: yaml """ import xml.etree.ElementTree as XML @@ -96,32 +122,76 @@ class Matrix(jenkins_jobs.modules.base.Base): 'yaml': 'org.jenkinsci.plugins.yamlaxis.YamlAxis', } + supported_strategies = { + # Jenkins built-in, default + 'execution-strategy': + 'hudson.matrix.DefaultMatrixExecutionStrategyImpl', + 'yaml-strategy': + 'org.jenkinsci.plugins.yamlaxis.YamlMatrixExecutionStrategy', + } + def root_xml(self, data): root = XML.Element('matrix-project') - ex_r = XML.SubElement(root, 'executionStrategy', - {'class': 'hudson.matrix.' - 'DefaultMatrixExecutionStrategyImpl'}) - ex_d = data.get('execution-strategy', {}) - XML.SubElement(root, 'combinationFilter').text = \ - str(ex_d.get('combination-filter', '')).rstrip() - XML.SubElement(ex_r, 'runSequentially').text = \ - str(ex_d.get('sequential', False)).lower() - if 'touchstone' in ex_d: - XML.SubElement(ex_r, 'touchStoneCombinationFilter').text = \ - str(ex_d['touchstone'].get('expr', '')) - t_r = XML.SubElement(ex_r, 'touchStoneResultCondition') - n = ex_d['touchstone'].get('result', 'stable').upper() - if n not in ('STABLE', 'UNSTABLE'): - raise ValueError('Required result must be stable or unstable') - - XML.SubElement(t_r, 'name').text = n - if n == "STABLE": - XML.SubElement(t_r, 'ordinal').text = '0' - XML.SubElement(t_r, 'color').text = 'BLUE' - else: - XML.SubElement(t_r, 'ordinal').text = '1' - XML.SubElement(t_r, 'color').text = 'YELLOW' + # Default to 'execution-strategy' + strategies = ([s for s in data.keys() if s.endswith('-strategy')] + or ['execution-strategy']) + + # Job can not have multiple strategies + if len(strategies) > 1: + raise ValueError( + 'matrix-project does not support multiple strategies. ' + 'Given %s: %s' % (len(strategies), ', '.join(strategies))) + strategy = strategies[0] + + if strategy not in self.supported_strategies: + raise ValueError( + 'Given strategy %s. Only %s strategies are supported' + % (strategy, self.supported_strategies.keys())) + + ex_r = XML.SubElement( + root, 'executionStrategy', + {'class': self.supported_strategies[strategy]}) + + ex_d = data.get(strategy, {}) + + if strategy == 'execution-strategy': + XML.SubElement(root, 'combinationFilter').text = \ + str(ex_d.get('combination-filter', '')).rstrip() + XML.SubElement(ex_r, 'runSequentially').text = \ + str(ex_d.get('sequential', False)).lower() + if 'touchstone' in ex_d: + XML.SubElement(ex_r, 'touchStoneCombinationFilter').text = \ + str(ex_d['touchstone'].get('expr', '')) + t_r = XML.SubElement(ex_r, 'touchStoneResultCondition') + n = ex_d['touchstone'].get('result', 'stable').upper() + if n not in ('STABLE', 'UNSTABLE'): + raise ValueError('Required result must be stable ' + 'or unstable') + + XML.SubElement(t_r, 'name').text = n + if n == "STABLE": + XML.SubElement(t_r, 'ordinal').text = '0' + XML.SubElement(t_r, 'color').text = 'BLUE' + else: + XML.SubElement(t_r, 'ordinal').text = '1' + XML.SubElement(t_r, 'color').text = 'YELLOW' + elif strategy == 'yaml-strategy': + filename = str(ex_d.get('filename', '')) + text = str(ex_d.get('text', '')) + exclude_key = str(ex_d.get('exclude-key', '')) + + if bool(filename) == bool(text): # xor with str + raise ValueError('yaml-strategy must be given ' + 'either "filename" or "text"') + + yamlType = (filename and 'file') or (text and 'text') + XML.SubElement(ex_r, 'yamlType').text = yamlType + + XML.SubElement(ex_r, 'yamlFile').text = filename + XML.SubElement(ex_r, 'yamlText').text = text + + XML.SubElement(ex_r, 'excludeKey').text = exclude_key ax_root = XML.SubElement(root, 'axes') for axis_ in data.get('axes', []): diff --git a/tests/general/fixtures/matrix-axis-yaml-strategy-file.xml b/tests/general/fixtures/matrix-axis-yaml-strategy-file.xml new file mode 100644 index 00000000..bfd14c02 --- /dev/null +++ b/tests/general/fixtures/matrix-axis-yaml-strategy-file.xml @@ -0,0 +1,29 @@ + + + + file + exclude.yaml + + exclude + + + + python + + config.yaml + + + + database + + config.yaml + + + + + false + false + false + false + true + diff --git a/tests/general/fixtures/matrix-axis-yaml-strategy-file.yaml b/tests/general/fixtures/matrix-axis-yaml-strategy-file.yaml new file mode 100644 index 00000000..8bd59c63 --- /dev/null +++ b/tests/general/fixtures/matrix-axis-yaml-strategy-file.yaml @@ -0,0 +1,14 @@ +name: matrix-with-yaml-strategy-and-exclude-in-file +project-type: matrix +yaml-strategy: + exclude-key: 'exclude' + filename: 'exclude.yaml' +axes: + - axis: + type: yaml + filename: 'config.yaml' + name: python + - axis: + type: yaml + filename: 'config.yaml' + name: database diff --git a/tests/general/fixtures/matrix-axis-yaml-strategy-inlined.xml b/tests/general/fixtures/matrix-axis-yaml-strategy-inlined.xml new file mode 100644 index 00000000..14284f12 --- /dev/null +++ b/tests/general/fixtures/matrix-axis-yaml-strategy-inlined.xml @@ -0,0 +1,34 @@ + + + + text + + exclude: + - database: postgre + python: py27 + - python: py35 + database: mysql + + exclude + + + + python + + config.yaml + + + + database + + config.yaml + + + + + false + false + false + false + true + diff --git a/tests/general/fixtures/matrix-axis-yaml-strategy-inlined.yaml b/tests/general/fixtures/matrix-axis-yaml-strategy-inlined.yaml new file mode 100644 index 00000000..835fa054 --- /dev/null +++ b/tests/general/fixtures/matrix-axis-yaml-strategy-inlined.yaml @@ -0,0 +1,19 @@ +name: matrix-with-yaml-strategy-and-inlined-exclude +project-type: matrix +yaml-strategy: + exclude-key: 'exclude' + text: | + exclude: + - database: postgre + python: py27 + - python: py35 + database: mysql +axes: + - axis: + type: yaml + filename: config.yaml + name: python + - axis: + type: yaml + filename: config.yaml + name: database -- cgit