Differential D201

Naming convention changes
ClosedPublic
Actions

Authored by lbrabec on Aug 12 2014, 2:38 PM.

Details

Reviewers
kparal
tflink
jskladan
Maniphest Tasks
T213: adjust libtaskotron terminology - formula, actions
Commits
rLTRN1d2197646525: Naming convention changes (formula and actions)
Summary

task yaml files are now called task formulae
task section in formula is now called actions

Test Plan

$ py.test -F testing/

$ make docs
and check the docs

Diff Detail

Repository
rLTRN libtaskotron
Lint
Lint Skipped
Unit
Unit Tests Skipped
lbrabec retitled this revision from to Naming convention changes.Aug 12 2014, 2:38 PM
lbrabec updated this object.
lbrabec edited the test plan for this revision. (Show Details)
lbrabec added a reviewer: kparal.
kparal added reviewers: tflink, jskladan.Aug 13 2014, 11:06 AM

Seems good. I'd rename the anchor as well.

Have you tried py.test -F? Just checking, the description doesn't say.

Adding more reviewers, let's wait for at least one more ack.

docs/source/taskyaml.rst
1

Should this anchor get renamed as well?

7–11

Typo in formula.

lbrabec edited the test plan for this revision. (Show Details)Aug 13 2014, 11:15 AM
lbrabec updated this revision to Diff 585.Aug 13 2014, 11:16 AM
  • typos and polishing
jskladan requested changes to this revision.Aug 13 2014, 11:46 AM

Make sure that all the task occurrences are properly replaced with actions.

docs/source/quickstart.rst
52–53

I might not understand it correctly, but should this not be actions instead?

testing/test_taskformula.py
31

actions ?

62

actions

70

actions

This revision now requires changes to proceed.Aug 13 2014, 11:46 AM
kparal requested changes to this revision.Aug 13 2014, 11:55 AM
kparal added inline comments.
libtaskotron/runner.py
128–129

And this should probably read

"At least one action should be specified in task formula file"

lbrabec updated this revision to Diff 590.Aug 14 2014, 11:40 AM
  • polishing
jskladan requested changes to this revision.Aug 14 2014, 11:48 AM
jskladan added inline comments.
libtaskotron/runner.py
177

Are you sure that the content of D202 should really be here? #justsaying

This revision now requires changes to proceed.Aug 14 2014, 11:48 AM
jskladan accepted this revision.Aug 14 2014, 11:55 AM

Probably a glitch in Phab which did not show the current develop as it should have. Ignore the previous comment and

Macro doge: very push

lbrabec closed this revision.Aug 14 2014, 11:58 AM
lbrabec updated this revision to Diff 591.

Closed by commit rLTRN1d2197646525 (authored by @lbrabec).

Revision Contents

Diff 591

View Options

docs/source/index.rst

1========================== 1​==========================
2Libtaskotron Documentation 2​Libtaskotron Documentation
3========================== 3​==========================
4 4​
5What is libtaskotron? 5​What is libtaskotron?
6===================== 6​=====================
7 7​
8Libtaskotron is one of the core components which make up the `Taskotron`_ 8​Libtaskotron is one of the core components which make up the `Taskotron`_
9system. Libtaskotron is responsible for running tasks written in 9​system. Libtaskotron is responsible for running tasks written in
10:ref:`taskotron-yaml-format`. 10​:ref:`taskotron-formula-format`.
11 11​
12While libtaskotron was designed for use with `Fedora <http://fedoraproject.org>`_, 12​While libtaskotron was designed for use with `Fedora <http://fedoraproject.org>`_,
13the Fedora specific parts are isolated and the core should be usable with any 13​the Fedora specific parts are isolated and the core should be usable with any
14recent Linux distribution. 14​recent Linux distribution.
15 15​
16Libtaskotron and Taskotron should be considered Alpha software. They are 16​Libtaskotron and Taskotron should be considered Alpha software. They are
17currently under very heavy development and will likely change until we stabilize 17​currently under very heavy development and will likely change until we stabilize
18the interfaces. 18​the interfaces.
▲ Show 20 Lines • Show All 106 Lines • Show Last 20 Lines
View Options

docs/source/quickstart.rst

Show All 25 Lines
26 26​
27:: 27​::
28 28​
29 runtask -i <item> -t <type> -a <arch> <yaml recipe> 29​ runtask -i <item> -t <type> -a <arch> <yaml recipe>
30 30​
31`More details on running tasks <index.html#running-tasks>`_ 31​`More details on running tasks <index.html#running-tasks>`_
32 32​
33 33​
34Recipes: General Syntax 34​Formulae: General Syntax
35======================= 35​========================
36 36​
37.. code-block:: yaml 37​.. code-block:: yaml
38 38​
39 name: name of recipe 39​ name: polyjuice potion
40 desc: slow cooked beef short ribs 40​ desc: potion that allows to take the form of someone else
41 maintainer: chef 41​ maintainer: hermione
42 42​
43 input: 43​ input:
44 args: 44​ args:
45 - arg1 # supported args: 45​ - arg1 # supported args:
46 - arg2 # arch, koji_build, bodhi_id, koji_tag 46​ - arg2 # arch, koji_build, bodhi_id, koji_tag
47 47​
48 environment: 48​ environment:
49 rpm: 49​ rpm:
50 - dependency1 # not checked in current version 50​ - dependency1 # not checked in current version
51 - dependency2 # only for human reference 51​ - dependency2 # only for human reference
52 52​
53 task: 53​ actions:
jskladanUnsubmitted
Not Done

I might not understand it correctly, but should this not be actions instead?

54 - name: preheat the oven 54​ - name: pick fluxweed on a full moon
55 directivename: # e.g. koji, bodhi, python, ... 55​ directivename: # e.g. koji, bodhi, python, ...
56 arg1: value1 56​ arg1: value1
57 arg2: ${some_variable} # e.g. input arg 57​ arg2: ${some_variable} # e.g. input arg
58 export: firststep_output # export usable as input arg of next directive 58​ export: firststep_output # export usable as input arg of next directive
59 59​
60 - name: next step of recipe 60​ - name: next step of formula
61 nextdirectivename: 61​ nextdirectivename:
62 arg1: ${firststep_output} 62​ arg1: ${firststep_output}
63 63​
64`Detailed instructions on writing tasks <writingtasks.html#creating-a-new-task>`_ 64​`Detailed instructions on writing tasks <writingtasks.html#creating-a-new-task>`_
65 65​
66 66​
67Recipes: Examples From Our Git 67​Recipes: Examples From Our Git
68============================== 68​==============================
Show All 26 Lines
View Options

docs/source/taskyaml.rst

1.. _taskotron-yaml-format: 1​.. _taskotron-formula-format:
kparalUnsubmitted
Not Done

Should this anchor get renamed as well?

2 2​
3========================== 3​=============================
4Taskotron Task YAML Format 4​Taskotron Task Formula Format
5========================== 5​=============================
6 6​
7One of the core bits of Taskotron is the yaml file used to describe tasks to be 7​One of the core bits of Taskotron is the formula yaml file used to describe
8run. As Taskotron is still a very young project, some components of the task yaml 8​tasks to be run. As Taskotron is still a very young project, some components
9files are not yet used by the task runner but are useful to human readers of 9​of the task formulae are not yet used by the task runner but are useful to human
10the task. Those sections will be noted and those notes updated as things change. 10​readers of the task. Those sections will be noted and those notes updated as
11​things change.
kparalUnsubmitted
Not Done

Typo in formula.

11 12​
12The documentation here is a description of how things are implemented but are 13​The documentation here is a description of how things are implemented but are
13a little light on the practical creation of tasks. :ref:`writing-tasks-for-taskotron` 14​a little light on the practical creation of tasks. :ref:`writing-tasks-for-taskotron`
14and some existing tasks are also good references: 15​and some existing tasks are also good references:
15 16​
16 * `rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_ 17​ * `rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_
17 * `examplebodhi <https://bitbucket.org/fedoraqa/task-examplebodhi>`_ 18​ * `examplebodhi <https://bitbucket.org/fedoraqa/task-examplebodhi>`_
18 19​
19Task Description 20​Task Description
20================ 21​================
21 22​
22Metadata 23​Metadata
23-------- 24​--------
24 25​
25Some metadata is required to be in the task yaml file: 26​Some metadata is required to be in the task formula:
26 27​
27 * task name 28​ * task name
28 * description 29​ * description
29 * maintainer 30​ * maintainer
30 31​
31.. code-block:: yaml 32​.. code-block:: yaml
32 33​
33 --- 34​ ---
▲ Show 20 Lines • Show All 187 Lines • Show Last 20 Lines
View Options

docs/source/writingtasks.rst

Show First 20 Lines • Show All 56 Lines • ▼ Show 20 Line(s)55creating something new. To write a new task, you'll need some information:
57 * What type of object will the task be run against? 57​ * What type of object will the task be run against?
58 58​
59 * What will be the name of the task? 59​ * What will be the name of the task?
60 60​
61 * What are the dependencies? 61​ * What are the dependencies?
62 62​
63 63​
64The taskotron runner works on specially formatted YAML files (see 64​The taskotron runner works on specially formatted YAML files (see
65:ref:`taskotron-yaml-format` for details) which describe the task that is to 65​:ref:`taskotron-formula-format` for details) called formulae which describe
66be executed. In addition to the task YAML file, any other code or resources needed 66​the task that is to be executed. In addition to the task formula, any other code
67for task execution should be accessible by the runner. 67​or resources needed for task execution should be accessible by the runner.
68 68​
69A directory layout could look like:: 69​A directory layout could look like::
70 70​
71 mytask/ 71​ mytask/
72 mytask.yml 72​ mytask.yml
73 mytask.py 73​ mytask.py
74 someresource.txt 74​ someresource.txt
75 75​
▲ Show 20 Lines • Show All 184 Lines • Show Last 20 Lines
View Options

libtaskotron/runner.py

1# -*- coding: utf-8 -*- 1​# -*- coding: utf-8 -*-
2# Copyright 2009-2014, Red Hat, Inc. 2​# Copyright 2009-2014, Red Hat, Inc.
3# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> 3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4# See the LICENSE file for more details on Licensing 4​# See the LICENSE file for more details on Licensing
5 5​
6from __future__ import absolute_import 6​from __future__ import absolute_import
7import logging 7​import logging
8import tempfile 8​import tempfile
9import os.path 9​import os.path
10import argparse 10​import argparse
11import imp 11​import imp
12import copy 12​import copy
13import collections 13​import collections
14 14​
15from libtaskotron import taskyaml 15​from libtaskotron import taskformula
16from libtaskotron import logger 16​from libtaskotron import logger
17from libtaskotron import python_utils 17​from libtaskotron import python_utils
18from libtaskotron import config 18​from libtaskotron import config
19from libtaskotron.logger import log 19​from libtaskotron.logger import log
20from libtaskotron.exceptions import TaskotronYamlError 20​from libtaskotron.exceptions import TaskotronYamlError
21 21​
22 22​
23# The list of accepted item types on the command line (--type option) 23​# The list of accepted item types on the command line (--type option)
▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Line(s)52 def _load_directive(self, directive_name, directive_dir=None):
65 loaded_directive = imp.load_source(real_name, directive_file) 65​ loaded_directive = imp.load_source(real_name, directive_file)
66 self.directives[directive_name] = loaded_directive 66​ self.directives[directive_name] = loaded_directive
67 67​
68 def _render_action(self, action): 68​ def _render_action(self, action):
69 '''Take an action and replace all included variables with actual values 69​ '''Take an action and replace all included variables with actual values
70 from :attr:`env_data` and :attr:`working_data`. See :meth:`do_actions` 70​ from :attr:`env_data` and :attr:`working_data`. See :meth:`do_actions`
71 to see how an action looks like. 71​ to see how an action looks like.
72 72​
73 :param dict action: An action specification parsed from the task yaml 73​ :param dict action: An action specification parsed from the task formula
74 file ​
75 :return: a rendered action 74​ :return: a rendered action
76 :rtype: dict 75​ :rtype: dict
77 ''' 76​ '''
78 # copy the input so that we don't disrupt what we're processing 77​ # copy the input so that we don't disrupt what we're processing
79 rendered_action = copy.deepcopy(action) 78​ rendered_action = copy.deepcopy(action)
80 79​
81 variables = copy.deepcopy(self.envdata) 80​ variables = copy.deepcopy(self.envdata)
82 variables.update(self.working_data) 81​ variables.update(self.working_data)
83 taskyaml.replace_vars_in_action(rendered_action, variables) 82​ taskformula.replace_vars_in_action(rendered_action, variables)
84 83​
85 return rendered_action 84​ return rendered_action
86 85​
87 def _extract_directive_from_action(self, action): 86​ def _extract_directive_from_action(self, action):
88 for key in action: 87​ for key in action:
89 if key not in ['name', 'export']: 88​ if key not in ['name', 'export']:
90 return key 89​ return key
91 raise TaskotronYamlError('no directive found in action %s' % 90​ raise TaskotronYamlError('no directive found in action %s' %
92 str(action)) 91​ str(action))
93 92​
94 def do_single_action(self, action): 93​ def do_single_action(self, action):
95 '''Execute a single action from the task. See :meth:`do_actions` to see 94​ '''Execute a single action from the task. See :meth:`do_actions` to see
96 how an action looks like. 95​ how an action looks like.
97 96​
98 :param dict action: An action specification parsed from the task yaml 97​ :param dict action: An action specification parsed from the task formula
99 file ​
100 ''' 98​ '''
101 directive_name = self._extract_directive_from_action(action) 99​ directive_name = self._extract_directive_from_action(action)
102 100​
103 rendered_action = self._render_action(action) 101​ rendered_action = self._render_action(action)
104 102​
105 log.debug("Executing directive: %s", directive_name) 103​ log.debug("Executing directive: %s", directive_name)
106 self._load_directive(directive_name) 104​ self._load_directive(directive_name)
107 105​
108 directive_object = self.directives[directive_name] 106​ directive_object = self.directives[directive_name]
109 directive_classname = directive_object.directive_class 107​ directive_classname = directive_object.directive_class
110 108​
111 directive_callable = getattr(directive_object, directive_classname)() 109​ directive_callable = getattr(directive_object, directive_classname)()
112 110​
113 output = directive_callable.process(rendered_action[directive_name], 111​ output = directive_callable.process(rendered_action[directive_name],
114 self.envdata) 112​ self.envdata)
115 113​
116 if 'export' in action: 114​ if 'export' in action:
117 self.working_data[action['export']] = output 115​ self.working_data[action['export']] = output
118 116​
119 def do_actions(self): 117​ def do_actions(self):
120 '''Sequentially run all actions for a task. An 'action' is a single step 118​ '''Sequentially run all actions for a task. An 'action' is a single step
121 under the ``task:`` key. An example action looks like:: 119​ under the ``actions:`` key. An example action looks like::
122 120​
123 - name: download rpms from koji 121​ - name: download rpms from koji
124 koji: 122​ koji:
125 action: download 123​ action: download
126 koji_build: $koji_build 124​ koji_build: $koji_build
127 arch: $arch 125​ arch: $arch
128 ''' 126​ '''
129 if 'task' not in self.taskdata or not self.taskdata['task']: 127​ if 'actions' not in self.taskdata or not self.taskdata['actions']:
130 raise TaskotronYamlError("At least one task should be specified" 128​ raise TaskotronYamlError("At least one task should be specified"
131 " in input yaml file") 129​ " in input formula")
kparalUnsubmitted
Not Done

And this should probably read

"At least one action should be specified in task formula file"

132 130​
133 for action in self.taskdata['task']: 131​ for action in self.taskdata['actions']:
134 self.do_single_action(action) 132​ self.do_single_action(action)
135 133​
136 def _validate_input(self): 134​ def _validate_input(self):
137 if 'input' not in self.taskdata: 135​ if 'input' not in self.taskdata:
138 return 136​ return
139 137​
140 if not isinstance(self.taskdata['input'], collections.Mapping): 138​ if not isinstance(self.taskdata['input'], collections.Mapping):
141 raise TaskotronYamlError("Input yaml should contain correct 'input'" 139​ raise TaskotronYamlError("Input yaml should contain correct 'input'"
Show All 29 Lines160def get_argparser():
171 parser.add_argument("-t", "--type", 169​ parser.add_argument("-t", "--type",
172 choices=_ITEM_TYPES, 170​ choices=_ITEM_TYPES,
173 help="type of --item argument") 171​ help="type of --item argument")
174 parser.add_argument("-j", "--jobid", default="-1", 172​ parser.add_argument("-j", "--jobid", default="-1",
175 help="optional job identifier used to render log urls") 173​ help="optional job identifier used to render log urls")
176 parser.add_argument("-d", "--debug", action="store_true", 174​ parser.add_argument("-d", "--debug", action="store_true",
177 help="Enable debug output " 175​ help="Enable debug output "
178 "(set logging level to 'DEBUG')") 176​ "(set logging level to 'DEBUG')")
179 parser.add_argument("--override", action="append", default=[], 177​ parser.add_argument("--override", action="append", default=[],
jskladanUnsubmitted
Not Done

Are you sure that the content of D202 should really be here? #justsaying

180 metavar='VAR=VALUE', 178​ metavar='VAR=VALUE',
181 help="override internal variable values used in runner " 179​ help="override internal variable values used in runner "
182 "and the task formula. Value itself is evaluated " 180​ "and the task formula. Value itself is evaluated "
183 "by eval(). This option can be used multiple times. " 181​ "by eval(). This option can be used multiple times. "
184 "Example: --override \"workdir='/some/dir/'\"") 182​ "Example: --override \"workdir='/some/dir/'\"")
185 183​
186 return parser 184​ return parser
187 185​
▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Line(s)216def main():
229 227​
230 # full logging initialization 228​ # full logging initialization
231 level_stream = logging.DEBUG if args.debug else None 229​ level_stream = logging.DEBUG if args.debug else None
232 logger.init(level_stream=level_stream) 230​ logger.init(level_stream=level_stream)
233 231​
234 arg_data = process_args(vars(args)) 232​ arg_data = process_args(vars(args))
235 arg_data['taskfile'] = args.task[0] 233​ arg_data['taskfile'] = args.task[0]
236 234​
237 # parse task yaml file 235​ # parse task formula
238 task_data = taskyaml.parse_yaml_from_file(arg_data['taskfile']) 236​ task_data = taskformula.parse_yaml_from_file(arg_data['taskfile'])
239 if not task_data: 237​ if not task_data:
240 raise TaskotronYamlError('Input file should not be empty') 238​ raise TaskotronYamlError('Input file should not be empty')
241 239​
242 # run the task 240​ # run the task
243 task_runner = Runner(task_data, arg_data) 241​ task_runner = Runner(task_data, arg_data)
244 task_runner.run() 242​ task_runner.run()
245 243​
246 # finalization 244​ # finalization
247 log.info('Check execution finished. Showing stored variables:') 245​ log.info('Check execution finished. Showing stored variables:')
248 for name, value in task_runner.working_data.items(): 246​ for name, value in task_runner.working_data.items():
249 log.info("${%s}:\n%s" % (name, value)) 247​ log.info("${%s}:\n%s" % (name, value))
View Options

libtaskotron/taskformula.py

  • This file was moved from libtaskotron/taskyaml.py.
1# -*- coding: utf-8 -*- 1​# -*- coding: utf-8 -*-
2# Copyright 2009-2014, Red Hat, Inc. 2​# Copyright 2009-2014, Red Hat, Inc.
3# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> 3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4# See the LICENSE file for more details on Licensing 4​# See the LICENSE file for more details on Licensing
5 5​
6'''Methods for operating with a task YAML file''' 6​'''Methods for operating with a task formula'''
7 7​
8from __future__ import absolute_import 8​from __future__ import absolute_import
9import collections 9​import collections
10import string 10​import string
11 11​
12import yaml 12​import yaml
13from libtaskotron import exceptions as exc 13​from libtaskotron import exceptions as exc
14from libtaskotron.logger import log 14​from libtaskotron.logger import log
15 15​
16 16​
17def parse_yaml_from_file(filename): 17​def parse_yaml_from_file(filename):
18 with open(filename, 'r') as datafile: 18​ with open(filename, 'r') as datafile:
19 return parse_yaml(datafile.read()) 19​ return parse_yaml(datafile.read())
20 20​
21 21​
22def parse_yaml(contents): 22​def parse_yaml(contents):
23 return yaml.safe_load(contents) 23​ return yaml.safe_load(contents)
24 24​
25 25​
26def _replace_vars(text, variables): 26​def _replace_vars(text, variables):
27 '''Go through ``text`` and replace all variables (in the form of what is 27​ '''Go through ``text`` and replace all variables (in the form of what is
28 supported by :class:`string.Template`) with their values, as provided in 28​ supported by :class:`string.Template`) with their values, as provided in
29 ``variables``. This is used for variable expansion in the task yaml file. 29​ ``variables``. This is used for variable expansion in the task formula.
30 30​
31 :param str text: input text where to search for variables 31​ :param str text: input text where to search for variables
32 :param dict variables: names (keys) and values of variables to replace 32​ :param dict variables: names (keys) and values of variables to replace
33 :return: if ``text`` contains just a single variable and nothing else, the 33​ :return: if ``text`` contains just a single variable and nothing else, the
34 variable value is directly returned (i.e. with matching type, not 34​ variable value is directly returned (i.e. with matching type, not
35 cast to ``str``). If ``text`` contains something else as well 35​ cast to ``str``). If ``text`` contains something else as well
36 (other variables or text), a string is returned. 36​ (other variables or text), a string is returned.
37 :raise TaskotronYamlError: if ``text`` contains a variable that is not 37​ :raise TaskotronYamlError: if ``text`` contains a variable that is not
Show All 19 Lines42 try:
57 57​
58 # Now it's clear there's also something else in `text` than just a 58​ # Now it's clear there's also something else in `text` than just a
59 # single variable. We will replace all variables and return a string 59​ # single variable. We will replace all variables and return a string
60 # again. 60​ # again.
61 output = string.Template(text).substitute(variables) 61​ output = string.Template(text).substitute(variables)
62 return output 62​ return output
63 63​
64 except KeyError as e: 64​ except KeyError as e:
65 raise exc.TaskotronYamlError("The task yaml file includes a variable, " 65​ raise exc.TaskotronYamlError("The task formula includes a variable, "
66 "but no value has been provided for it: %s" % e) 66​ "but no value has been provided for it: %s" % e)
67 67​
68 except ValueError as e: 68​ except ValueError as e:
69 raise exc.TaskotronYamlError("The task yaml file includes an incorrect " 69​ raise exc.TaskotronYamlError("The task formula includes an incorrect "
70 "variable definition. Dollar signs must be doubled if they " 70​ "variable definition. Dollar signs must be doubled if they "
71 "shouldn't be considered as a variable denotation.\n" 71​ "shouldn't be considered as a variable denotation.\n"
72 "Error: %s\n" 72​ "Error: %s\n"
73 "Text: %s" % (e, text)) 73​ "Text: %s" % (e, text))
74 74​
75 75​
76def replace_vars_in_action(action, variables): 76​def replace_vars_in_action(action, variables):
77 '''Find all variables that are leaves (in a tree sense) in an action. Leaves 77​ '''Find all variables that are leaves (in a tree sense) in an action. Leaves
78 are variables which can no longer be traversed, i.e. "primitive" types like 78​ are variables which can no longer be traversed, i.e. "primitive" types like
79 ``str`` or ``int``. Non-leaves are containers like ``dict`` or ``list``. 79​ ``str`` or ``int``. Non-leaves are containers like ``dict`` or ``list``.
80 80​
81 For all leaves, call :func:`_replace_vars` and update their value with 81​ For all leaves, call :func:`_replace_vars` and update their value with
82 the function's output. 82​ the function's output.
83 83​
84 :param dict action: An action specification parsed from the task yaml file. 84​ :param dict action: An action specification parsed from the task formula.
85 See :meth:`.Runner.do_actions` to see what an action 85​ See :meth:`.Runner.do_actions` to see what an action
86 looks like. 86​ looks like.
87 :param dict variables: names (keys) and values of variables to replace 87​ :param dict variables: names (keys) and values of variables to replace
88 :raise TaskotronYamlError: if ``text`` contains a variable that is not 88​ :raise TaskotronYamlError: if ``text`` contains a variable that is not
89 present in ``variables``, or if the variable 89​ present in ``variables``, or if the variable
90 syntax is incorrect 90​ syntax is incorrect
91 ''' 91​ '''
92 92​
Show All 27 Lines
View Options

libtaskotron/taskyaml.py

  • This file was moved to libtaskotron/taskformula.py.
View Options

testing/test_runner.py

Show First 20 Lines • Show All 220 Lines • ▼ Show 20 Line(s)220class TestRunnerDoActions():
221 221​
222 def setup_method(self, method): 222​ def setup_method(self, method):
223 self.ref_taskdata = {} 223​ self.ref_taskdata = {}
224 self.ref_inputdata = {} 224​ self.ref_inputdata = {}
225 225​
226 def test_runner_do_single_dummy_pass(self): 226​ def test_runner_do_single_dummy_pass(self):
227 ref_action = {'name': 'Dummy Action', 227​ ref_action = {'name': 'Dummy Action',
228 'dummy': {'result': 'pass'}} 228​ 'dummy': {'result': 'pass'}}
229 self.ref_taskdata = {'task': [ref_action]} 229​ self.ref_taskdata = {'actions': [ref_action]}
230 230​
231 test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata) 231​ test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata)
232 232​
233 test_runner.do_actions() 233​ test_runner.do_actions()
234 234​
235 def test_runner_do_single_dummy_fail(self): 235​ def test_runner_do_single_dummy_fail(self):
236 ref_action = {'name': 'Dummy Action', 236​ ref_action = {'name': 'Dummy Action',
237 'dummy': {'result': 'fail'}} 237​ 'dummy': {'result': 'fail'}}
238 self.ref_taskdata = {'task': [ref_action]} 238​ self.ref_taskdata = {'actions': [ref_action]}
239 239​
240 test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata) 240​ test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata)
241 241​
242 with pytest.raises(exc.TaskotronDirectiveError): 242​ with pytest.raises(exc.TaskotronDirectiveError):
243 test_runner.do_actions() 243​ test_runner.do_actions()
244 244​
245 def test_runner_do_multiple_dummy_fail(self): 245​ def test_runner_do_multiple_dummy_fail(self):
246 ref_action = {'name': 'Dummy Action', 246​ ref_action = {'name': 'Dummy Action',
247 'dummy': {'result': 'fail'}} 247​ 'dummy': {'result': 'fail'}}
248 self.ref_taskdata = {'task': [ref_action, ref_action]} 248​ self.ref_taskdata = {'actions': [ref_action, ref_action]}
249 249​
250 test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata) 250​ test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata)
251 251​
252 with pytest.raises(exc.TaskotronDirectiveError): 252​ with pytest.raises(exc.TaskotronDirectiveError):
253 test_runner.do_actions() 253​ test_runner.do_actions()
254 254​
255 def test_runner_do_multiple_dummy_pass_export_rendered_msg(self): 255​ def test_runner_do_multiple_dummy_pass_export_rendered_msg(self):
256 ref_exportname = 'dummy_output' 256​ ref_exportname = 'dummy_output'
257 ref_message = 'This is a variable message' 257​ ref_message = 'This is a variable message'
258 ref_messagename = 'variable_messsage' 258​ ref_messagename = 'variable_messsage'
259 ref_action = {'name': 'Dummy Action', 259​ ref_action = {'name': 'Dummy Action',
260 'dummy': {'result': 'pass', 260​ 'dummy': {'result': 'pass',
261 'msg': '${%s}' % ref_messagename}, 261​ 'msg': '${%s}' % ref_messagename},
262 'export': '%s' % ref_exportname} 262​ 'export': '%s' % ref_exportname}
263 263​
264 self.ref_taskdata = {'task': [ref_action, ref_action]} 264​ self.ref_taskdata = {'actions': [ref_action, ref_action]}
265 265​
266 test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata) 266​ test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata)
267 test_runner.working_data[ref_messagename] = ref_message 267​ test_runner.working_data[ref_messagename] = ref_message
268 268​
269 test_runner.do_actions() 269​ test_runner.do_actions()
270 270​
271 assert test_runner.working_data[ref_exportname] == ref_message 271​ assert test_runner.working_data[ref_exportname] == ref_message
272 272​
273 def test_runner_fails_missing_action(self): 273​ def test_runner_fails_missing_action(self):
274 self.ref_taskdata = {'task': None} 274​ self.ref_taskdata = {'actions': None}
275 275​
276 test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata) 276​ test_runner = runner.Runner(self.ref_taskdata, self.ref_inputdata)
277 277​
278 with pytest.raises(exc.TaskotronYamlError): 278​ with pytest.raises(exc.TaskotronYamlError):
279 test_runner.do_actions() 279​ test_runner.do_actions()
280 280​
281 def test_runner_fails_missing_task(self): 281​ def test_runner_fails_missing_task(self):
282 self.ref_taskdata = {} 282​ self.ref_taskdata = {}
▲ Show 20 Lines • Show All 156 Lines • Show Last 20 Lines
View Options

testing/test_taskformula.py

  • This file was moved from testing/test_taskyaml.py.
1# -*- coding: utf-8 -*- 1​# -*- coding: utf-8 -*-
2# Copyright 2009-2014, Red Hat, Inc. 2​# Copyright 2009-2014, Red Hat, Inc.
3# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> 3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4# See the LICENSE file for more details on Licensing 4​# See the LICENSE file for more details on Licensing
5 5​
6'''Unit tests for libtaskotron/taskyaml.py''' 6​'''Unit tests for libtaskotron/taskformula.py'''
7 7​
8import copy 8​import copy
9 9​
10import yaml 10​import yaml
11import pytest 11​import pytest
12from libtaskotron import taskyaml 12​from libtaskotron import taskformula
13import libtaskotron.exceptions as exc 13​import libtaskotron.exceptions as exc
14 14​
15 15​
16ref_taskname = 'testtask' 16​ref_taskname = 'testtask'
17ref_taskdesc = 'this is a test task' 17​ref_taskdesc = 'this is a test task'
18ref_maintainer = 'testuser' 18​ref_maintainer = 'testuser'
19ref_deps = ['libtaskotron', 'libpanacea'] 19​ref_deps = ['libtaskotron', 'libpanacea']
20ref_input = {'args': 'arch, koji_build'} 20​ref_input = {'args': 'arch, koji_build'}
21ref_actions = [] 21​ref_actions = []
22 22​
23 23​
24def create_yamldata(name=ref_taskname, desc=ref_taskdesc, maint=ref_maintainer, 24​def create_yamldata(name=ref_taskname, desc=ref_taskdesc, maint=ref_maintainer,
25 deps=ref_deps, input_=ref_input, actions=ref_actions): 25​ deps=ref_deps, input_=ref_input, actions=ref_actions):
26 return {'name': name, 26​ return {'name': name,
27 'desc': desc, 27​ 'desc': desc,
28 'maintainer': maint, 28​ 'maintainer': maint,
29 'deps': deps, 29​ 'deps': deps,
30 'input': input_, 30​ 'input': input_,
31 'task': actions} 31​ 'actions': actions}
jskladanUnsubmitted
Not Done

actions ?

32 32​
33 33​
34class TestTaskYamlMetadata(object): 34​class TestTaskYamlMetadata(object):
35 def setup_method(self, method): 35​ def setup_method(self, method):
36 self.taskdata = create_yamldata() 36​ self.taskdata = create_yamldata()
37 self.test_task = taskyaml.parse_yaml(yaml.safe_dump(self.taskdata)) 37​ self.test_task = taskformula.parse_yaml(yaml.safe_dump(self.taskdata))
38 38​
39 def test_taskyaml_taskname(self): 39​ def test_taskyaml_taskname(self):
40 assert self.test_task['name'] == self.taskdata['name'] 40​ assert self.test_task['name'] == self.taskdata['name']
41 41​
42 def test_taskyaml_taskdesc(self): 42​ def test_taskyaml_taskdesc(self):
43 assert self.test_task['desc'] == self.taskdata['desc'] 43​ assert self.test_task['desc'] == self.taskdata['desc']
44 44​
45 def test_taskyaml_taskmaintainer(self): 45​ def test_taskyaml_taskmaintainer(self):
46 assert self.test_task['maintainer'] == self.taskdata['maintainer'] 46​ assert self.test_task['maintainer'] == self.taskdata['maintainer']
47 47​
48 def test_taskyaml_taskdeps(self): 48​ def test_taskyaml_taskdeps(self):
49 assert self.test_task['deps'] == self.taskdata['deps'] 49​ assert self.test_task['deps'] == self.taskdata['deps']
50 50​
51 def test_taskyaml_taskinput(self): 51​ def test_taskyaml_taskinput(self):
52 assert self.test_task['input'] == self.taskdata['input'] 52​ assert self.test_task['input'] == self.taskdata['input']
53 53​
54 54​
55class TestTaskYamlActionsNoVariables(object): 55​class TestTaskYamlActionsNoVariables(object):
56 def test_taskyaml_simple_action(self): 56​ def test_taskyaml_simple_action(self):
57 ref_action = {'name': 'testaction', 'action': {'key': 'value'}} 57​ ref_action = {'name': 'testaction', 'action': {'key': 'value'}}
58 taskdata = create_yamldata(actions=[ref_action]) 58​ taskdata = create_yamldata(actions=[ref_action])
59 59​
60 test_task = taskyaml.parse_yaml(yaml.safe_dump(taskdata)) 60​ test_task = taskformula.parse_yaml(yaml.safe_dump(taskdata))
61 61​
62 assert test_task['task'][0] == ref_action 62​ assert test_task['actions'][0] == ref_action
jskladanUnsubmitted
Not Done

actions

63 63​
64 def test_taskyaml_multiple_actions(self): 64​ def test_taskyaml_multiple_actions(self):
65 ref_action = {'name': 'testaction', 'action': {'key': 'value'}} 65​ ref_action = {'name': 'testaction', 'action': {'key': 'value'}}
66 taskdata = create_yamldata(actions=[ref_action, ref_action, ref_action]) 66​ taskdata = create_yamldata(actions=[ref_action, ref_action, ref_action])
67 67​
68 test_task = taskyaml.parse_yaml(yaml.safe_dump(taskdata)) 68​ test_task = taskformula.parse_yaml(yaml.safe_dump(taskdata))
69 69​
70 assert len(test_task['task']) == 3 70​ assert len(test_task['actions']) == 3
jskladanUnsubmitted
Not Done

actions

71 71​
72 72​
73class TestReplaceVarsInAction(object): 73​class TestReplaceVarsInAction(object):
74 74​
75 def setup_method(self, method): 75​ def setup_method(self, method):
76 self.action = { 76​ self.action = {
77 'name': 'run foo${foo}', 77​ 'name': 'run foo${foo}',
78 'export': '${export}', 78​ 'export': '${export}',
Show All 23 Lines99 def test_complex(self):
102 rend_action['export'] = self.vars['export'] 102​ rend_action['export'] = self.vars['export']
103 rend_action['python']['args'] = ['arg1', self.vars['number'], 'arg2', 103​ rend_action['python']['args'] = ['arg1', self.vars['number'], 'arg2',
104 self.vars['list'], self.vars['dict']] 104​ self.vars['list'], self.vars['dict']]
105 rend_action['python']['cmdline'] = '-s %s -i %s' % (self.vars['foo'], 105​ rend_action['python']['cmdline'] = '-s %s -i %s' % (self.vars['foo'],
106 self.vars['number']) 106​ self.vars['number'])
107 rend_action['python']['nest']['deepnest'] = self.vars['dict'] 107​ rend_action['python']['nest']['deepnest'] = self.vars['dict']
108 rend_action['python']['nest']['null'] = self.vars['null'] 108​ rend_action['python']['nest']['null'] = self.vars['null']
109 109​
110 taskyaml.replace_vars_in_action(self.action, self.vars) 110​ taskformula.replace_vars_in_action(self.action, self.vars)
111 assert self.action == rend_action 111​ assert self.action == rend_action
112 112​
113 def test_raise(self): 113​ def test_raise(self):
114 with pytest.raises(exc.TaskotronYamlError): 114​ with pytest.raises(exc.TaskotronYamlError):
115 taskyaml.replace_vars_in_action(self.action, {}) 115​ taskformula.replace_vars_in_action(self.action, {})
116 116​
117 del self.vars['number'] 117​ del self.vars['number']
118 with pytest.raises(exc.TaskotronYamlError): 118​ with pytest.raises(exc.TaskotronYamlError):
119 taskyaml.replace_vars_in_action(self.action, self.vars) 119​ taskformula.replace_vars_in_action(self.action, self.vars)
120 120​
121 121​
122class TestReplaceVars(object): 122​class TestReplaceVars(object):
123 123​
124 def test_standadlone_var_str(self): 124​ def test_standadlone_var_str(self):
125 res = taskyaml._replace_vars('${foo}', {'foo': 'hedgehog'}) 125​ res = taskformula._replace_vars('${foo}', {'foo': 'hedgehog'})
126 assert res == 'hedgehog' 126​ assert res == 'hedgehog'
127 127​
128 def test_standalone_var_nonstr(self): 128​ def test_standalone_var_nonstr(self):
129 res = taskyaml._replace_vars('${foo}', {'foo': ['chicken', 'egg']}) 129​ res = taskformula._replace_vars('${foo}', {'foo': ['chicken', 'egg']})
130 assert res == ['chicken', 'egg'] 130​ assert res == ['chicken', 'egg']
131 131​
132 def test_standadlone_var_str_alternative(self): 132​ def test_standadlone_var_str_alternative(self):
133 res = taskyaml._replace_vars('$foo', {'foo': 'hedgehog'}) 133​ res = taskformula._replace_vars('$foo', {'foo': 'hedgehog'})
134 assert res == 'hedgehog' 134​ assert res == 'hedgehog'
135 135​
136 def test_standalone_var_nonstr_alternative(self): 136​ def test_standalone_var_nonstr_alternative(self):
137 res = taskyaml._replace_vars('$foo', {'foo': ['chicken', 'egg']}) 137​ res = taskformula._replace_vars('$foo', {'foo': ['chicken', 'egg']})
138 assert res == ['chicken', 'egg'] 138​ assert res == ['chicken', 'egg']
139 139​
140 def test_multivar(self): 140​ def test_multivar(self):
141 res = taskyaml._replace_vars('a ${b} c${d}', {'b': 'bb', 'd': 'dd'}) 141​ res = taskformula._replace_vars('a ${b} c${d}', {'b': 'bb', 'd': 'dd'})
142 assert res == 'a bb cdd' 142​ assert res == 'a bb cdd'
143 143​
144 def test_empty_space(self): 144​ def test_empty_space(self):
145 '''Some empty space around a single variable is like multi-var, i.e. 145​ '''Some empty space around a single variable is like multi-var, i.e.
146 a string is always returned''' 146​ a string is always returned'''
147 res = taskyaml._replace_vars(' ${foo}', {'foo': 'bar'}) 147​ res = taskformula._replace_vars(' ${foo}', {'foo': 'bar'})
148 assert res == ' bar' 148​ assert res == ' bar'
149 149​
150 res = taskyaml._replace_vars(' ${foo}', {'foo': 42}) 150​ res = taskformula._replace_vars(' ${foo}', {'foo': 42})
151 assert res == ' 42' 151​ assert res == ' 42'
152 152​
153 def test_recursive_content(self): 153​ def test_recursive_content(self):
154 '''The content of a variable contains more variable names. But those 154​ '''The content of a variable contains more variable names. But those
155 must not be expanded.''' 155​ must not be expanded.'''
156 text = '${foo} ${bar}' 156​ text = '${foo} ${bar}'
157 varz = {'foo': '${foo} ${bar}', 157​ varz = {'foo': '${foo} ${bar}',
158 'bar': '${foo} ${bar} ${baz}' 158​ 'bar': '${foo} ${bar} ${baz}'
159 } 159​ }
160 res = taskyaml._replace_vars(text, varz) 160​ res = taskformula._replace_vars(text, varz)
161 assert res == '%s %s' % (varz['foo'], varz['bar']) 161​ assert res == '%s %s' % (varz['foo'], varz['bar'])
162 162​
163 def test_empty(self): 163​ def test_empty(self):
164 res = taskyaml._replace_vars('', {'extra': 'var'}) 164​ res = taskformula._replace_vars('', {'extra': 'var'})
165 assert res == '' 165​ assert res == ''
166 166​
167 def test_same_var(self): 167​ def test_same_var(self):
168 '''Only variables must get replaced, not same-sounding text''' 168​ '''Only variables must get replaced, not same-sounding text'''
169 res = taskyaml._replace_vars('foo ${foo}', {'foo': 'bar'}) 169​ res = taskformula._replace_vars('foo ${foo}', {'foo': 'bar'})
170 assert res == 'foo bar' 170​ assert res == 'foo bar'
171 171​
172 def test_combined_syntax(self): 172​ def test_combined_syntax(self):
173 '''Both $foo and ${foo} syntax must work, together with escaping''' 173​ '''Both $foo and ${foo} syntax must work, together with escaping'''
174 res = taskyaml._replace_vars('foo $foo ${foo} $$foo', {'foo': 'bar'}) 174​ res = taskformula._replace_vars('foo $foo ${foo} $$foo', {'foo': 'bar'})
175 assert res == 'foo bar bar $foo' 175​ assert res == 'foo bar bar $foo'
176 176​
177 def test_raise_missing_var(self): 177​ def test_raise_missing_var(self):
178 with pytest.raises(exc.TaskotronYamlError): 178​ with pytest.raises(exc.TaskotronYamlError):
179 taskyaml._replace_vars('${foo}', {'bar': 'foo'}) 179​ taskformula._replace_vars('${foo}', {'bar': 'foo'})
180 180​
181 def test_raise_missing_vars(self): 181​ def test_raise_missing_vars(self):
182 with pytest.raises(exc.TaskotronYamlError): 182​ with pytest.raises(exc.TaskotronYamlError):
183 taskyaml._replace_vars('${foo} ${bar}', {'bar': 'foo'}) 183​ taskformula._replace_vars('${foo} ${bar}', {'bar': 'foo'})
184 184​
185 def test_raise_bad_escape(self): 185​ def test_raise_bad_escape(self):
186 '''Dollars must be doubled''' 186​ '''Dollars must be doubled'''
187 with pytest.raises(exc.TaskotronYamlError): 187​ with pytest.raises(exc.TaskotronYamlError):
188 taskyaml._replace_vars('${foo} $', {'foo': 'bar'}) 188​ taskformula._replace_vars('${foo} $', {'foo': 'bar'})
189 189​
View Options

testing/test_taskyaml.py

  • This file was moved to testing/test_taskformula.py.