There's some complicated logic, so an assert at the end is always handy
to make sure it works correctly. This can't be easily unit tested.
This is to complement D368. The purpose is to have the sanity check in a single place, instead of checking it at every task that uses that method.
test suite passes. I also introduced an error in that method manually and verified that it will raise that assertion error.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | libtaskotron/bodhi_utils.py (14 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| 908e214aac3a | 71093059ed1c | 53ae972c67ac | Kamil Páral | bodhi_utils: add safety check to build2update() (Show More…) | May 6 2015, 12:15 PM |
| Show First 20 Lines • Show All 102 Lines • ▼ Show 20 Line(s) | 97 | :return: a tuple of two dictionaries: | |||
|---|---|---|---|---|---|
| 103 | * The second dict provides mapping between ``builds`` and their | 103 | * The second dict provides mapping between ``builds`` and their | ||
| 104 | updates where some error occured. The value is ``None`` if | 104 | updates where some error occured. The value is ``None`` if | ||
| 105 | the matching Bodhi update could not be found (the only | 105 | the matching Bodhi update could not be found (the only | ||
| 106 | possible cause of failure if ``strict=False``). Or the value | 106 | possible cause of failure if ``strict=False``). Or the value | ||
| 107 | is a Bodhi update that was incomplete (happens only if | 107 | is a Bodhi update that was incomplete (happens only if | ||
| 108 | ``strict=True``). | 108 | ``strict=True``). | ||
| 109 | 109 | | |||
| 110 | ``{build (string): Bodhi update (Bunch) or None}`` | 110 | ``{build (string): Bodhi update (Bunch) or None}`` | ||
| 111 | * The set of keys in both these dictionaries correspond exactly | ||||
| 112 | to ``builds``. For every build provided in ``builds`` you'll | ||||
| 113 | get an answer in either the first or the second dictionary, | ||||
| 114 | and there will be no extra builds that you haven't specified. | ||||
| 111 | :raise TaskotronValueError: if ``builds`` type is incorrect | 115 | :raise TaskotronValueError: if ``builds`` type is incorrect | ||
| 112 | ''' | 116 | ''' | ||
| 113 | # validate input params | 117 | # validate input params | ||
| 114 | if not python_utils.iterable(builds, basestring): | 118 | if not python_utils.iterable(builds, basestring): | ||
| 115 | raise exc.TaskotronValueError("Param 'builds' must be an iterable " | 119 | raise exc.TaskotronValueError("Param 'builds' must be an iterable " | ||
| 116 | "of strings, and yours was: %s" % type(builds)) | 120 | "of strings, and yours was: %s" % type(builds)) | ||
| 117 | 121 | | |||
| 118 | build2update = {} | 122 | build2update = {} | ||
| ▲ Show 20 Lines • Show All 50 Lines • ▼ Show 20 Line(s) | |||||
| 169 | # it from @var build2update and keep it in @var failures. | 173 | # it from @var build2update and keep it in @var failures. | ||
| 170 | for build in failures: | 174 | for build in failures: | ||
| 171 | if build in build2update: | 175 | if build in build2update: | ||
| 172 | log.warn("The build %s is a part of two different updates: '%s'" | 176 | log.warn("The build %s is a part of two different updates: '%s'" | ||
| 173 | " and '%s'. That's probably a bug in Bodhi." % (build, | 177 | " and '%s'. That's probably a bug in Bodhi." % (build, | ||
| 174 | failures[build]['title'], build2update[build]['title'])) | 178 | failures[build]['title'], build2update[build]['title'])) | ||
| 175 | del build2update[build] | 179 | del build2update[build] | ||
| 176 | 180 | | |||
| 181 | # a safety check: 'build2update' combined with 'failures' should contain | ||||
| 182 | # exactly the same builds as in the input 'builds' param. There's no | ||||
| 183 | # reason this should go wrong, ever. | ||||
| 184 | diff = set(builds).symmetric_difference( | ||||
| 185 | set(build2update.keys()).union(set(failures.keys()))) | ||||
| 186 | assert not diff, ("There should be no difference between input and " | ||||
| 187 | "output builds.\nInput: %s\nBuild2update: %s\n" | ||||
| 188 | "Failures: %s\nDiff: %s" % (builds, build2update.keys(), | ||||
| 189 | failures.keys(), diff)) | ||||
| 190 | | ||||
| 177 | return (build2update, failures) | 191 | return (build2update, failures) | ||