/usr/lib/python3/dist-packages/checkbox/parsers/description.py is in python3-checkbox 0.17.6-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | #
# This file is part of Checkbox.
#
# Copyright 2011 Canonical Ltd.
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.
#
# Checkbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Checkbox. If not, see <http://www.gnu.org/licenses/>.
#
import re
from checkbox.lib.enum import Enum
DescriptionState = Enum(
"INIT",
"PURPOSE",
"STEPS",
"INFO",
"VERIFICATION",
"OTHER")
TransitionStates = {
DescriptionState.INIT: DescriptionState.PURPOSE,
DescriptionState.PURPOSE: DescriptionState.STEPS,
DescriptionState.STEPS: DescriptionState.VERIFICATION,
DescriptionState.INFO: DescriptionState.VERIFICATION,
DescriptionState.VERIFICATION: DescriptionState.OTHER,
DescriptionState.OTHER: DescriptionState.OTHER,
}
# PURPOSE string:
# 1. Foo
# substitute to:
# Foo
PURPOSE_RE = re.compile(r"(\d+)\.(\s+)", re.M)
# STEPS string:
# 1: Foo
# substitute to:
# 1. Foo
STEPS_RE = re.compile(r"(\d+):(\s+)", re.M)
class DescriptionParser:
"""Parser for the description field in jobs."""
def __init__(self, stream):
self.stream = stream
def run(self, result):
parts = {}
state = DescriptionState.INIT
for line in self.stream.readlines():
# Check for upper case characters without leading spaces.
if not line[0].isspace() \
and line.isupper():
state = TransitionStates[state]
# Append to description parts between INIT and OTHER states.
elif state > DescriptionState.INIT \
and state < DescriptionState.OTHER:
# Handle optional INFO state and translations of $output.
if state == DescriptionState.VERIFICATION \
and "$" in line:
state = DescriptionState.INFO
line = "$output\n"
parts.setdefault(state, "")
parts[state] += line.lstrip()
# Only set the description if the last state is still VERIFICATION.
if state == DescriptionState.VERIFICATION:
# Substitute the PURPOSE part
parts[DescriptionState.PURPOSE] = PURPOSE_RE.sub(
r"", parts[DescriptionState.PURPOSE])
# Substitute the STEPS part
parts[DescriptionState.STEPS] = STEPS_RE.sub(
r"\1.\2", parts[DescriptionState.STEPS])
result.setDescription(
parts[DescriptionState.PURPOSE],
parts[DescriptionState.STEPS],
parts[DescriptionState.VERIFICATION],
parts.get(DescriptionState.INFO))
|