This file is indexed.

/usr/lib/python3/dist-packages/plainbox/impl/test_clitools.py is in python3-plainbox 0.25-1.

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
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# This file is part of Checkbox.
#
# Copyright 2014 Canonical Ltd.
# Written by:
#   Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
#
# 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/>.

"""
plainbox.impl.test_clitools
===========================

Test definitions for plainbox.impl.clitools module
"""

from unittest import TestCase

from plainbox.impl.clitools import CommandBase


class DummyCommand(CommandBase):
    """
    Concrete implementation of the abstract CommandBase class, for testing
    """

    def invoked(self):
        raise NotImplementedError()

    def register_parser(self, subparsers):
        raise NotImplementedError()


class TestCommandBase(TestCase):
    """
    Test cases for CommandBase
    """

    def test_get_command_name(self):
        """
        verify various modes of CommandBase.get_command_name()
        """
        # If class has a name attribute, just use it
        class TheFooCmd(DummyCommand):
            name = "foo"

        self.assertEqual(TheFooCmd().get_command_name(), "foo")

        # Otherwise just use lower-case class name
        class Foo(DummyCommand):
            pass

        self.assertEqual(Foo().get_command_name(), "foo")

        # The word "command" is stripped from the class name though
        class FooCommand(DummyCommand):
            pass

        self.assertEqual(FooCommand().get_command_name(), "foo")

    def test_get_command_help(self):
        """
        verify various modes of CommandBase.get_command_help()
        """
        # If class has a help attribute, just use it
        class Foo(DummyCommand):
            help = "help text"

        self.assertEqual(Foo().get_command_help(), "help text")

        # Otherwise use the first line of the docstring
        class Foo(DummyCommand):
            """
            help text

            other stuff
            """

        self.assertEqual(Foo().get_command_help(), "help text")

        # If there is no docstring, there is no help either
        class Foo(DummyCommand):
            pass

        self.assertEqual(Foo().get_command_help(), None)

    def test_get_command_description(self):
        """
        verify various modes of CommandBase.get_command_description()
        """
        # If class has a description attribute, just use it
        class Foo(DummyCommand):
            description = "description"

        self.assertEqual(Foo().get_command_description(), "description")

        # Otherwise use the docstring skipping the first line
        class Foo(DummyCommand):
            """
            help text

            description
            """

        self.assertEqual(Foo().get_command_description(), "description")

        # The description runs until the end of the docstring or
        # until the string @EPILOG@
        class Foo(DummyCommand):
            """
            help text

            description

            @EPILOG@

            other stuff
            """

        self.assertEqual(Foo().get_command_description(), "description")

        # If there is no docstring, there is no description either
        class Foo(DummyCommand):
            pass

        self.assertEqual(Foo().get_command_description(), None)

    def test_get_command_epilog(self):
        """
        verify various modes of CommandBase.get_command_epilog()
        """
        # If class has a epilog attribute, just use it
        class Foo(DummyCommand):
            epilog = "epilog"

        self.assertEqual(Foo().get_command_epilog(), "epilog")

        # Otherwise use the docstring after the @EPILOG@ string
        class Foo(DummyCommand):
            """
            help text

            other stuff

            @EPILOG@

            epilog
            """

        self.assertEqual(Foo().get_command_epilog(), "epilog")

        # If the @EPILOG@ line isn't present, there is no epilog
        class Foo(DummyCommand):
            """
            help text

            other stuff
            """

        self.assertEqual(Foo().get_command_epilog(), None)

        # If there is no docstring, there is no epilog either
        class Foo(DummyCommand):
            pass

        self.assertEqual(Foo().get_command_epilog(), None)