coalib.tests.misc.RunShellCommandTest - Code Metrics - Inspection of "Makman2/git-commit-bear" - coala-analyzer/coala - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#1228)

by Mischa

created 2016-01-22 19:09 UTC

coalib.tests.misc.RunShellCommandTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Metric	Value
dl	0
loc	67
rs	10
wmc	14

6 Methods

Rating	Name	Size	Complexity
A	test_run_shell_command_kwargs_delegation()	7	3
A	construct_testscript_command()	8	2
B	test_run_interactive_shell_command_kwargs_delegation()	10	5
A	test_run_input_shell_command()	13	1
A	test_run_noninteractive_shell_command()	11	1
A	test_run_interactive_shell_command()	11	2

import os
import sys
import unittest

sys.path.insert(0, ".")
from coalib.misc.Shell import (prepare_string_argument,
                               escape_path_argument,
                               run_interactive_shell_command,
                               run_shell_command)


class ShellTest(unittest.TestCase):
    # Tests the function that makes a path shell-argument-ready.

    def test_escape_path_argument(self):
        osname = "Linux"
        self.assertEqual(
            escape_path_argument("/home/usr/a-file", osname),
            "/home/usr/a-file")
        self.assertEqual(
            escape_path_argument("/home/usr/a-dir/", osname),
            "/home/usr/a-dir/")
        self.assertEqual(
            escape_path_argument("/home/us r/a-file with spaces.bla", osname),
            "/home/us\\ r/a-file\\ with\\ spaces.bla")
        self.assertEqual(
            escape_path_argument("/home/us r/a-dir with spaces/x/", osname),
            "/home/us\\ r/a-dir\\ with\\ spaces/x/")
        self.assertEqual(
            escape_path_argument(
                "relative something/with cherries and/pickles.delicious",
                osname),
            "relative\\ something/with\\ cherries\\ and/pickles.delicious")

        osname = "Windows"
        self.assertEqual(
            escape_path_argument("C:\\Windows\\has-a-weird-shell.txt", osname),
            "\"C:\\Windows\\has-a-weird-shell.txt\"")
        self.assertEqual(
            escape_path_argument("C:\\Windows\\lolrofl\\dirs\\", osname),
            "\"C:\\Windows\\lolrofl\\dirs\\\"")
        self.assertEqual(
            escape_path_argument("X:\\Users\\Maito Gai\\fi le.exe", osname),
            "\"X:\\Users\\Maito Gai\\fi le.exe\"")
        self.assertEqual(
            escape_path_argument("X:\\Users\\Mai to Gai\\director y\\",
                                 osname),
            "\"X:\\Users\\Mai to Gai\\director y\\\"")
        self.assertEqual(
            escape_path_argument("X:\\Users\\Maito Gai\\\"seven-gates\".y",
                                 osname),
            "\"X:\\Users\\Maito Gai\\^\"seven-gates^\".y\"")
        self.assertEqual(
            escape_path_argument("System32\\my-custom relative tool\\",
                                 osname),
            "\"System32\\my-custom relative tool\\\"")
        self.assertEqual(
            escape_path_argument("System32\\illegal\" name \"\".curd", osname),
            "\"System32\\illegal^\" name ^\"^\".curd\"")

        osname = "INVALID"
        self.assertEqual(
            escape_path_argument("/home/usr/a-file", osname),
            "/home/usr/a-file")
        self.assertEqual(
            escape_path_argument("/home/us r/a-file with spaces.bla", osname),
            "/home/us r/a-file with spaces.bla")
        self.assertEqual(
            escape_path_argument("|home|us r|a*dir with spaces|x|", osname),
            "|home|us r|a*dir with spaces|x|")
        self.assertEqual(
            escape_path_argument("system|a|b|c?d", osname),
            "system|a|b|c?d")


class RunShellCommandTest(unittest.TestCase):

    @staticmethod
    def construct_testscript_command(scriptname):
        return " ".join(
            escape_path_argument(s) for s in (
                escape_path_argument(sys.executable),
                os.path.join(os.path.dirname(os.path.realpath(__file__)),
                             "run_shell_command_testfiles",
                             scriptname)))

    def test_run_interactive_shell_command(self):
        command = RunShellCommandTest.construct_testscript_command(
            "test_interactive_program.py")

        with run_interactive_shell_command(command) as p:
            self.assertEqual(p.stdout.readline(), "test_program X\n")
            self.assertEqual(p.stdout.readline(), "Type in a number:\n")
            p.stdin.write("33\n")
            p.stdin.flush()
            self.assertEqual(p.stdout.readline(), "33\n")
            self.assertEqual(p.stdout.readline(), "Exiting program.\n")

    def test_run_interactive_shell_command_kwargs_delegation(self):
        with self.assertRaises(TypeError):
            with run_interactive_shell_command("some_command",
                                               weird_parameter=30):
                pass

        # Test one of the forbidden parameters.
        with self.assertRaises(TypeError):
            with run_interactive_shell_command("some_command", shell=False):
                pass

    def test_run_noninteractive_shell_command(self):
        command = RunShellCommandTest.construct_testscript_command(
            "test_program.py")

        stdout, stderr = run_shell_command(command)

        expected = ("test_program Z\n"
                    "non-interactive mode.\n"
                    "Exiting...\n")
        self.assertEqual(stdout, expected)
        self.assertEqual(stderr, "")

    def test_run_input_shell_command(self):
        command = RunShellCommandTest.construct_testscript_command(
            "test_input_program.py")

        stdout, stderr = run_shell_command(command, "1  4  10  22")

        self.assertEqual(stdout, "37\n")
        self.assertEqual(stderr, "")

        stdout, stderr = run_shell_command(command, "1 p 5")

        self.assertEqual(stdout, "INVALID INPUT\n")
        self.assertEqual(stderr, "")

    def test_run_shell_command_kwargs_delegation(self):
        with self.assertRaises(TypeError):
            run_shell_command("super-cool-command", weird_parameter2="abc")

        # Test one of the forbidden parameters.
        with self.assertRaises(TypeError):
            run_shell_command("super-cool-command", universal_newlines=False)


class PrepareStringArgumentTest(unittest.TestCase):
    def setUp(self):
        self.test_strings = ("normal_string",
                             "string with spaces",
                             'string with quotes"a',
                             "string with s-quotes'b",
                             "bsn \n A",
                             "unrecognized \\q escape")

    def test_prepare_string_argument_linux(self):
        os = "Linux"
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
        expected_results = ('"normal_string"',
                            '"string with spaces"',
                            '"string with quotes\\"a"',
                            '"string with s-quotes\'b"',
                            '"bsn \n A"',
                            '"unrecognized \\q escape"')

        for string, result in zip(self.test_strings, expected_results):
            self.assertEqual(prepare_string_argument(string, os), result)

    def test_prepare_string_argument_windows(self):
        os = "Windows"
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
        expected_results = ('"normal_string"',
                            '"string with spaces"',
                            '"string with quotes^"a"',
                            '"string with s-quotes\'b"',
                            '"bsn ^\n\n A"',
                            '"unrecognized \\q escape"')

        for string, result in zip(self.test_strings, expected_results):
            self.assertEqual(prepare_string_argument(string, os), result)

    def test_prepare_string_argument_unsupported_os(self):
        os = "WeIrD_O/S"
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param

        for string in self.test_strings:
            self.assertEqual(prepare_string_argument(string, os), string)


if __name__ == '__main__':
    unittest.main(verbosity=2)


1			import os
2			import sys
3			import unittest
4
5			sys.path.insert(0, ".")
6			from coalib.misc.Shell import (prepare_string_argument,
7			escape_path_argument,
8			run_interactive_shell_command,
9			run_shell_command)
10
11
12			class ShellTest(unittest.TestCase):
13			# Tests the function that makes a path shell-argument-ready.
14
15			def test_escape_path_argument(self):
16			osname = "Linux"
17			self.assertEqual(
18			escape_path_argument("/home/usr/a-file", osname),
19			"/home/usr/a-file")
20			self.assertEqual(
21			escape_path_argument("/home/usr/a-dir/", osname),
22			"/home/usr/a-dir/")
23			self.assertEqual(
24			escape_path_argument("/home/us r/a-file with spaces.bla", osname),
25			"/home/us\\ r/a-file\\ with\\ spaces.bla")
26			self.assertEqual(
27			escape_path_argument("/home/us r/a-dir with spaces/x/", osname),
28			"/home/us\\ r/a-dir\\ with\\ spaces/x/")
29			self.assertEqual(
30			escape_path_argument(
31			"relative something/with cherries and/pickles.delicious",
32			osname),
33			"relative\\ something/with\\ cherries\\ and/pickles.delicious")
34
35			osname = "Windows"
36			self.assertEqual(
37			escape_path_argument("C:\\Windows\\has-a-weird-shell.txt", osname),
38			"\"C:\\Windows\\has-a-weird-shell.txt\"")
39			self.assertEqual(
40			escape_path_argument("C:\\Windows\\lolrofl\\dirs\\", osname),
41			"\"C:\\Windows\\lolrofl\\dirs\\\"")
42			self.assertEqual(
43			escape_path_argument("X:\\Users\\Maito Gai\\fi le.exe", osname),
44			"\"X:\\Users\\Maito Gai\\fi le.exe\"")
45			self.assertEqual(
46			escape_path_argument("X:\\Users\\Mai to Gai\\director y\\",
47			osname),
48			"\"X:\\Users\\Mai to Gai\\director y\\\"")
49			self.assertEqual(
50			escape_path_argument("X:\\Users\\Maito Gai\\\"seven-gates\".y",
51			osname),
52			"\"X:\\Users\\Maito Gai\\^\"seven-gates^\".y\"")
53			self.assertEqual(
54			escape_path_argument("System32\\my-custom relative tool\\",
55			osname),
56			"\"System32\\my-custom relative tool\\\"")
57			self.assertEqual(
58			escape_path_argument("System32\\illegal\" name \"\".curd", osname),
59			"\"System32\\illegal^\" name ^\"^\".curd\"")
60
61			osname = "INVALID"
62			self.assertEqual(
63			escape_path_argument("/home/usr/a-file", osname),
64			"/home/usr/a-file")
65			self.assertEqual(
66			escape_path_argument("/home/us r/a-file with spaces.bla", osname),
67			"/home/us r/a-file with spaces.bla")
68			self.assertEqual(
69			escape_path_argument("\|home\|us r\|a*dir with spaces\|x\|", osname),
70			"\|home\|us r\|a*dir with spaces\|x\|")
71			self.assertEqual(
72			escape_path_argument("system\|a\|b\|c?d", osname),
73			"system\|a\|b\|c?d")
74
75
76			class RunShellCommandTest(unittest.TestCase):
77
78			@staticmethod
79			def construct_testscript_command(scriptname):
80			return " ".join(
81			escape_path_argument(s) for s in (
82			escape_path_argument(sys.executable),
83			os.path.join(os.path.dirname(os.path.realpath(__file__)),
84			"run_shell_command_testfiles",
85			scriptname)))
86
87			def test_run_interactive_shell_command(self):
88			command = RunShellCommandTest.construct_testscript_command(
89			"test_interactive_program.py")
90
91			with run_interactive_shell_command(command) as p:
92			self.assertEqual(p.stdout.readline(), "test_program X\n")
93			self.assertEqual(p.stdout.readline(), "Type in a number:\n")
94			p.stdin.write("33\n")
95			p.stdin.flush()
96			self.assertEqual(p.stdout.readline(), "33\n")
97			self.assertEqual(p.stdout.readline(), "Exiting program.\n")
98
99			def test_run_interactive_shell_command_kwargs_delegation(self):
100			with self.assertRaises(TypeError):
101			with run_interactive_shell_command("some_command",
102			weird_parameter=30):
103			pass
104
105			# Test one of the forbidden parameters.
106			with self.assertRaises(TypeError):
107			with run_interactive_shell_command("some_command", shell=False):
108			pass
109
110			def test_run_noninteractive_shell_command(self):
111			command = RunShellCommandTest.construct_testscript_command(
112			"test_program.py")
113
114			stdout, stderr = run_shell_command(command)
115
116			expected = ("test_program Z\n"
117			"non-interactive mode.\n"
118			"Exiting...\n")
119			self.assertEqual(stdout, expected)
120			self.assertEqual(stderr, "")
121
122			def test_run_input_shell_command(self):
123			command = RunShellCommandTest.construct_testscript_command(
124			"test_input_program.py")
125
126			stdout, stderr = run_shell_command(command, "1 4 10 22")
127
128			self.assertEqual(stdout, "37\n")
129			self.assertEqual(stderr, "")
130
131			stdout, stderr = run_shell_command(command, "1 p 5")
132
133			self.assertEqual(stdout, "INVALID INPUT\n")
134			self.assertEqual(stderr, "")
135
136			def test_run_shell_command_kwargs_delegation(self):
137			with self.assertRaises(TypeError):
138			run_shell_command("super-cool-command", weird_parameter2="abc")
139
140			# Test one of the forbidden parameters.
141			with self.assertRaises(TypeError):
142			run_shell_command("super-cool-command", universal_newlines=False)
143
144
145			class PrepareStringArgumentTest(unittest.TestCase):
146			def setUp(self):
147			self.test_strings = ("normal_string",
148			"string with spaces",
149			'string with quotes"a',
150			"string with s-quotes'b",
151			"bsn \n A",
152			"unrecognized \\q escape")
153
154			def test_prepare_string_argument_linux(self):
155			os = "Linux"
			0 ignored issues – show Comprehensibility Bug introduced 2016-01-22 19:10 UTC by Report Bug Copy Issue Report `os` is re-defining a name which is already available in the outer-scope (previously defined on line `1`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
156			expected_results = ('"normal_string"',
157			'"string with spaces"',
158			'"string with quotes\\"a"',
159			'"string with s-quotes\'b"',
160			'"bsn \n A"',
161			'"unrecognized \\q escape"')
162
163			for string, result in zip(self.test_strings, expected_results):
164			self.assertEqual(prepare_string_argument(string, os), result)
165
166			def test_prepare_string_argument_windows(self):
167			os = "Windows"
			0 ignored issues – show Comprehensibility Bug introduced 2016-01-22 19:10 UTC by Report Bug Copy Issue Report `os` is re-defining a name which is already available in the outer-scope (previously defined on line `1`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
168			expected_results = ('"normal_string"',
169			'"string with spaces"',
170			'"string with quotes^"a"',
171			'"string with s-quotes\'b"',
172			'"bsn ^\n\n A"',
173			'"unrecognized \\q escape"')
174
175			for string, result in zip(self.test_strings, expected_results):
176			self.assertEqual(prepare_string_argument(string, os), result)
177
178			def test_prepare_string_argument_unsupported_os(self):
179			os = "WeIrD_O/S"
			0 ignored issues – show Comprehensibility Bug introduced 2016-01-22 19:10 UTC by Report Bug Copy Issue Report `os` is re-defining a name which is already available in the outer-scope (previously defined on line `1`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
180
181			for string in self.test_strings:
182			self.assertEqual(prepare_string_argument(string, os), string)
183
184
185			if __name__ == '__main__':
186			unittest.main(verbosity=2)
187

coala-analyzer / coala

Pull Request — master (#1228)

coalib.tests.misc.RunShellCommandTest A

Complexity

Size/Duplication

6 Methods

Duplication Side-by-Side

Filter issues like