Further refactored shell command tests into a subpackage.

nigel.stanger / process_podcast

Browse code Further refactored shell command tests into a subpackage. master
1 parent b55389d commit b4bbaf0ff0ed34d889fea72ff2c83b901b66c59b Nigel Stanger authored on 24 Sep 2018

Patch

Showing 13 changed files

Show notes View shell_command/shared_tests.py 100644 → 0
import unittest from shell_command import ShellCommand class ShellCommandSharedTestCase(unittest.TestCase): """Shared tests for ShellCommand and its subclasses.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set to # [] otherwise they hang around from previous tests. self.command = ShellCommand(input_options=[], output_options=[]) self.expected_executable = "" self.expected_base_options = [] self.expected_input_options = [] self.expected_filter_options = [] self.expected_output_options = [] def tearDown(self): """Clean up after test.""" self.command = None def test_base_options(self): """Test that base options match expected.""" self.assertEqual( self.command._base_options, self.expected_base_options) def test_input_options(self): """Test that input options match expected.""" self.assertEqual( self.command.input_options, self.expected_input_options) def test_output_options(self): """Test that output options match expected.""" self.assertEqual( self.command.output_options, self.expected_output_options) def test_executable_string(self): """Test that executable path matches expected.""" with self.subTest(msg="unquoted paths match"): self.assertEqual( self.command.executable_string(quote=False), self.expected_executable) with self.subTest(msg="unquoted paths match"): # Note: don't explicitly specify quoted value, because # the executable path will vary across different systems. self.assertEqual( self.command.executable_string(quote=True), ShellCommand.shellquote(self.expected_executable)) def test_argument_string(self): """Test that argument string matches expected.""" args = (self.expected_base_options + self.expected_input_options + self.expected_filter_options + self.expected_output_options) with self.subTest(msg="unquoted agruments match"): self.assertEqual( self.command.argument_string(quote=False), " ".join(args)) with self.subTest(msg="quoted agruments match"): self.assertEqual( self.command.argument_string(quote=True), " ".join([ShellCommand.shellquote(a) for a in args])) def test_argument_list(self): """Test that argument list matches expected.""" self.assertEqual(self.command.argument_list(), self.expected_base_options + self.expected_input_options + self.expected_filter_options + self.expected_output_options) def test_command_string(self): """Test that command string matches expected.""" args = (self.expected_base_options + self.expected_input_options + self.expected_filter_options + self.expected_output_options) expected_cmd_unquoted = ( "{exe} {arg}".format(exe=self.expected_executable, arg=" ".join(args)) ) expected_cmd_quoted = ( '{exe} {arg}'.format( exe=ShellCommand.shellquote(self.expected_executable), arg=" ".join([ShellCommand.shellquote(a) for a in args])) ) with self.subTest(msg="unquoted command string matches"): self.assertEqual( self.command.command_string(quote=False), expected_cmd_unquoted) with self.subTest(msg="quoted command string matches"): self.assertEqual( self.command.command_string(quote=True), expected_cmd_quoted)

Show notes View

shell_command/shared_tests.py 100644 → 0

import unittest

from shell_command import ShellCommand

class ShellCommandSharedTestCase(unittest.TestCase):
    """Shared tests for ShellCommand and its subclasses."""

def setUp(self):
        """Set up for test."""
        # Make sure the input and output options are explicitly set to
        # [] otherwise they hang around from previous tests.
        self.command = ShellCommand(input_options=[], output_options=[])
        self.expected_executable = ""
        self.expected_base_options = []
        self.expected_input_options = []
        self.expected_filter_options = []
        self.expected_output_options = []

def tearDown(self):
        """Clean up after test."""
        self.command = None

def test_base_options(self):
        """Test that base options match expected."""
        self.assertEqual(
            self.command._base_options, self.expected_base_options)
    
    def test_input_options(self):
        """Test that input options match expected."""
        self.assertEqual(
            self.command.input_options, self.expected_input_options)
    
    def test_output_options(self):
        """Test that output options match expected."""
        self.assertEqual(
            self.command.output_options, self.expected_output_options)
    
    def test_executable_string(self):
        """Test that executable path matches expected."""
        with self.subTest(msg="unquoted paths match"):
            self.assertEqual(
                self.command.executable_string(quote=False),
                self.expected_executable)
        with self.subTest(msg="unquoted paths match"):
            # Note: don't explicitly specify quoted value, because
            # the executable path will vary across different systems.
            self.assertEqual(
                self.command.executable_string(quote=True),
                ShellCommand.shellquote(self.expected_executable))

def test_argument_string(self):
        """Test that argument string matches expected."""
        args = (self.expected_base_options + self.expected_input_options +
            self.expected_filter_options + self.expected_output_options)
        with self.subTest(msg="unquoted agruments match"):
            self.assertEqual(
                self.command.argument_string(quote=False), " ".join(args))
        with self.subTest(msg="quoted agruments match"):
            self.assertEqual(
                self.command.argument_string(quote=True),
                " ".join([ShellCommand.shellquote(a) for a in args]))

def test_argument_list(self):
        """Test that argument list matches expected."""
        self.assertEqual(self.command.argument_list(),
            self.expected_base_options + self.expected_input_options +
            self.expected_filter_options + self.expected_output_options)

def test_command_string(self):
        """Test that command string matches expected."""
        args = (self.expected_base_options + self.expected_input_options +
            self.expected_filter_options + self.expected_output_options)
        expected_cmd_unquoted = (
            "{exe} {arg}".format(exe=self.expected_executable,
                arg=" ".join(args))
        )
        expected_cmd_quoted = (
            '{exe} {arg}'.format(
                exe=ShellCommand.shellquote(self.expected_executable),
                arg=" ".join([ShellCommand.shellquote(a) for a in args]))
        )
        with self.subTest(msg="unquoted command string matches"):
            self.assertEqual(
                self.command.command_string(quote=False),
                expected_cmd_unquoted)
        with self.subTest(msg="quoted command string matches"):
            self.assertEqual(
                self.command.command_string(quote=True), expected_cmd_quoted)

Show notes View shell_command/test_convert_command.py 100644 → 0
import shutil import unittest from shell_command import ConvertCommand from shell_command.shared_tests import ShellCommandSharedTestCase class ConvertCommandTestCase(ShellCommandSharedTestCase): """Test the ConvertCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. self.command = ConvertCommand( input_options=["in.pdf[12]"], output_options=["out.png"]) self.expected_executable = shutil.which("convert") self.expected_base_options = [ "-size", "2048x1536", "-density", "600", "xc:dimgrey", "null:", "(" ] self.expected_input_options = [ "in.pdf[12]", "-resize", "2048x1536", "-background", "white", "-alpha", "remove", "-type", "truecolor", "-define", "colorspace:auto-grayscale=off", ] self.expected_filter_options = [] self.expected_output_options = [ ")", "-gravity", "center", "-layers", "composite", "-flatten", "out.png", ] def tearDown(self): """Clean up after test.""" self.command = None # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Show notes View

shell_command/test_convert_command.py 100644 → 0

import shutil
import unittest

from shell_command import ConvertCommand
from shell_command.shared_tests import ShellCommandSharedTestCase

class ConvertCommandTestCase(ShellCommandSharedTestCase):
    """Test the ConvertCommand class."""

def setUp(self):
        """Set up for test."""
        # Make sure the input and output options are explicitly set,
        # otherwise they hang around from previous tests.
        self.command = ConvertCommand(
            input_options=["in.pdf[12]"], output_options=["out.png"])
        self.expected_executable = shutil.which("convert")
        self.expected_base_options = [
            "-size", "2048x1536",
            "-density", "600",
            "xc:dimgrey", "null:",
            "("
        ]
        self.expected_input_options = [
            "in.pdf[12]",
            "-resize", "2048x1536",
            "-background", "white", 
            "-alpha", "remove",
            "-type", "truecolor",
            "-define", "colorspace:auto-grayscale=off",
        ]
        self.expected_filter_options = []
        self.expected_output_options = [
            ")",
            "-gravity", "center",
            "-layers", "composite",
            "-flatten",
            "out.png",
        ]

def tearDown(self):
        """Clean up after test."""
        self.command = None

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Show notes View shell_command/test_ffmpeg_command.py 100644 → 0
import shutil from pathlib import Path import tempfile import unittest from shell_command import FFmpegCommand from shell_command.shared_tests import ShellCommandSharedTestCase class FFmpegCommandTestCase(ShellCommandSharedTestCase): """Test the FFmpegCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. self.command = FFmpegCommand( input_options=["-i", "in.mov"], output_options=["out.mov"]) self.expected_executable = shutil.which("ffmpeg") self.expected_base_options = ["-y", "-nostdin",] self.expected_input_options = ["-i", "in.mov"] self.expected_filter_options = [] self.expected_output_options = ["out.mov"] def tearDown(self): """Clean up after test.""" self.command = None # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Show notes View

shell_command/test_ffmpeg_command.py 100644 → 0

import shutil
from pathlib import Path
import tempfile
import unittest

from shell_command import FFmpegCommand
from shell_command.shared_tests import ShellCommandSharedTestCase

class FFmpegCommandTestCase(ShellCommandSharedTestCase):
    """Test the FFmpegCommand class."""

def setUp(self):
        """Set up for test."""
        # Make sure the input and output options are explicitly set,
        # otherwise they hang around from previous tests.
        self.command = FFmpegCommand(
            input_options=["-i", "in.mov"], output_options=["out.mov"])
        self.expected_executable = shutil.which("ffmpeg")
        self.expected_base_options = ["-y", "-nostdin",]
        self.expected_input_options = ["-i", "in.mov"]
        self.expected_filter_options = []
        self.expected_output_options = ["out.mov"]

def tearDown(self):
        """Clean up after test."""
        self.command = None

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Show notes View shell_command/test_ffmpeg_concat_command.py 100644 → 0
from datetime import timedelta from pathlib import Path import shutil import tempfile import unittest from unittest.mock import MagicMock from segment import Segment, AudioSegment, VideoSegment from shell_command import FFmpegConcatCommand from shell_command.shared_tests import ShellCommandSharedTestCase class FFmpegConcatCommandTestCase(ShellCommandSharedTestCase): """Test the FFmpegConcatCommand class.""" NORMALISATION_FILTER = "[aconc] dynaudnorm=r=0.25:f=10:b=y [anorm]" # What about testing different permutations of audio and video? def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. self.command = FFmpegConcatCommand( input_options=["-i", "in.mov"], output_options=["out.mov"], has_video=True, has_audio=True, quiet=True) self.expected_executable = shutil.which("ffmpeg") self.expected_base_options = ["-y", "-nostdin",] self.expected_input_options = ["-i", "in.mov"] self.expected_filter_options = ["-filter_complex", ""] self.expected_output_options = [ "-codec:a", self.command.audio_codec, "-ac", "1", "-map", "[anorm]", "-codec:v", self.command.video_codec, "-pix_fmt", "yuv420p", "-map", "[vconc]", "out.mov" ] def tearDown(self): """Clean up after test.""" self.command = None def test_append_filter(self): """Test appending to the filter list.""" test_data = ( ("", [], "append empty filter"), ("normal_filter", ["normal_filter"], "append normal filter"), ) for appended, expected, description in test_data: with self.subTest(msg=description): self.command.append_filter(appended) self.assertEqual(self.command.filters, expected) def test_append_normalisation_filter(self): """Test appending a normalisation filter.""" filters = [self.NORMALISATION_FILTER] self.command.append_normalisation_filter() self.assertEqual(self.command.filters, filters) def test_append_concat_filter(self): """Test appending various concat filters.""" test_data = ( ("a", "audio"), ("v", "video"), ("f", "frame (should be ignored)"), ) expected = [] for frame_type, description in test_data: for num_segments in range(0, 3): segments = None if frame_type == "a": segments = num_segments * [AudioSegment( file="file.in", punch_in=timedelta(), punch_out=timedelta(seconds=20), input_stream=0)] elif frame_type == "v": segments = num_segments * [VideoSegment( file="file.in", punch_in=timedelta(), punch_out=timedelta(seconds=20), input_stream=0)] elif frame_type == "f": # Frame segments should be ignored by # append_concat_filter() regardless. segments = [] else: raise TypeError self.command.append_concat_filter( frame_type=frame_type, segments=segments) if frame_type not in ["a", "v"]: # Ignore frame segments. pass elif num_segments > 1: expected.append( "{inspecs} concat=n={n}:v={v}:a={a} [{t}conc]".format( inspecs=" ".join([s.output_stream_specifier() for s in segments]), n=num_segments, v=int(frame_type == "v"), a=int(frame_type == "a"), t=frame_type) ) elif num_segments == 1: expected.append( "{inspec} {a}null [{t}conc]".format( inspec=segments[0].output_stream_specifier(), a=frame_type if frame_type == "a" else "", t=frame_type) ) with self.subTest( msg="{d}: {n}".format(d=description, n=num_segments)): self.assertEqual(self.command.filters, expected) def test_build_complex_filter(self): self.command.append_normalisation_filter() self.assertEqual( self.command.build_complex_filter(), self.NORMALISATION_FILTER) test_data = ( ("", self.NORMALISATION_FILTER, "append empty filter"), ("normal_filter", "{n};normal_filter".format(n=self.NORMALISATION_FILTER), "append normal filter"), ) for appended, expected, description in test_data: with self.subTest(msg=description): self.command.append_filter(appended) self.assertEqual(self.command.build_complex_filter(), expected) # process_pattern() updates the internal ProgressBar object. # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Show notes View

shell_command/test_ffmpeg_concat_command.py 100644 → 0

from datetime import timedelta
from pathlib import Path
import shutil
import tempfile
import unittest
from unittest.mock import MagicMock

from segment import Segment, AudioSegment, VideoSegment
from shell_command import FFmpegConcatCommand
from shell_command.shared_tests import ShellCommandSharedTestCase

class FFmpegConcatCommandTestCase(ShellCommandSharedTestCase):
    """Test the FFmpegConcatCommand class."""

NORMALISATION_FILTER = "[aconc] dynaudnorm=r=0.25:f=10:b=y [anorm]"

# What about testing different permutations of audio and video?
    def setUp(self):
        """Set up for test."""
        # Make sure the input and output options are explicitly set,
        # otherwise they hang around from previous tests.
        self.command = FFmpegConcatCommand(
            input_options=["-i", "in.mov"], output_options=["out.mov"],
            has_video=True, has_audio=True, quiet=True)
        self.expected_executable = shutil.which("ffmpeg")
        self.expected_base_options = ["-y", "-nostdin",]
        self.expected_input_options = ["-i", "in.mov"]
        self.expected_filter_options = ["-filter_complex", ""]
        self.expected_output_options = [
            "-codec:a", self.command.audio_codec,
            "-ac", "1",
            "-map", "[anorm]",
            "-codec:v", self.command.video_codec,
            "-pix_fmt", "yuv420p",
            "-map", "[vconc]",
            "out.mov"
        ]

def tearDown(self):
        """Clean up after test."""
        self.command = None
    
    def test_append_filter(self):
        """Test appending to the filter list."""
        test_data = (
            ("", [], "append empty filter"),
            ("normal_filter", ["normal_filter"], "append normal filter"),
        )
        for appended, expected, description in test_data:
            with self.subTest(msg=description):
                self.command.append_filter(appended)
                self.assertEqual(self.command.filters, expected)
    
    def test_append_normalisation_filter(self):
        """Test appending a normalisation filter."""
        filters = [self.NORMALISATION_FILTER]
        self.command.append_normalisation_filter()
        self.assertEqual(self.command.filters, filters)
    
    def test_append_concat_filter(self):
        """Test appending various concat filters."""
        test_data = (
            ("a", "audio"),
            ("v", "video"),
            ("f", "frame (should be ignored)"),
        )
        expected = []
        for frame_type, description in test_data:
            for num_segments in range(0, 3):
                segments = None
                if frame_type == "a":
                    segments = num_segments * [AudioSegment(
                        file="file.in", punch_in=timedelta(),
                        punch_out=timedelta(seconds=20), input_stream=0)]
                elif frame_type == "v":
                    segments = num_segments * [VideoSegment(
                        file="file.in", punch_in=timedelta(),
                        punch_out=timedelta(seconds=20), input_stream=0)]
                elif frame_type == "f":
                    # Frame segments should be ignored by
                    # append_concat_filter() regardless.
                    segments = []
                else:
                    raise TypeError
                self.command.append_concat_filter(
                    frame_type=frame_type, segments=segments)
                if frame_type not in ["a", "v"]:
                    # Ignore frame segments.
                    pass
                elif num_segments > 1:
                    expected.append(
                        "{inspecs} concat=n={n}:v={v}:a={a} [{t}conc]".format(
                            inspecs=" ".join([s.output_stream_specifier()
                                              for s in segments]),
                            n=num_segments, v=int(frame_type == "v"),
                            a=int(frame_type == "a"), t=frame_type)
                    )
                elif num_segments == 1:
                    expected.append(
                        "{inspec} {a}null [{t}conc]".format(
                            inspec=segments[0].output_stream_specifier(),
                            a=frame_type if frame_type == "a" else "",
                            t=frame_type)
                    )
                with self.subTest(
                        msg="{d}: {n}".format(d=description, n=num_segments)):
                    self.assertEqual(self.command.filters, expected)

def test_build_complex_filter(self):
        self.command.append_normalisation_filter()
        self.assertEqual(
            self.command.build_complex_filter(), self.NORMALISATION_FILTER)
        test_data = (
            ("", self.NORMALISATION_FILTER, "append empty filter"),
            ("normal_filter",
             "{n};normal_filter".format(n=self.NORMALISATION_FILTER),
             "append normal filter"),
        )
        for appended, expected, description in test_data:
            with self.subTest(msg=description):
                self.command.append_filter(appended)
                self.assertEqual(self.command.build_complex_filter(), expected)

# process_pattern() updates the internal ProgressBar object.

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Show notes View shell_command/test_ffprobe_command.py 100644 → 0
import shutil from pathlib import Path import tempfile import unittest from shell_command import FFprobeCommand from shell_command.shared_tests import ShellCommandSharedTestCase class FFprobeCommandTestCase(ShellCommandSharedTestCase): """Test the FFprobeCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. A fresh # temporary file is created for each test. self.tmpfile = tempfile.NamedTemporaryFile() self.command = FFprobeCommand( input_options=["-i", self.tmpfile.name], output_options=[]) self.expected_executable = shutil.which("ffprobe") self.expected_base_options = [ "-loglevel", "error", "-show_entries", "format:stream", "-print_format", "json", ] self.expected_input_options = ["-i", self.tmpfile.name] self.expected_filter_options = [] self.expected_output_options = [] def tearDown(self): """Clean up after test.""" self.tmpfile.close() self.command = None def test_last_modified(self): """Test that last modified time of temp file matches.""" self.assertEqual( self.command.last_modified, Path(self.tmpfile.name).stat().st_mtime) # get_entries()? # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Show notes View

shell_command/test_ffprobe_command.py 100644 → 0

import shutil
from pathlib import Path
import tempfile
import unittest

from shell_command import FFprobeCommand
from shell_command.shared_tests import ShellCommandSharedTestCase

class FFprobeCommandTestCase(ShellCommandSharedTestCase):
    """Test the FFprobeCommand class."""

def setUp(self):
        """Set up for test."""
        # Make sure the input and output options are explicitly set,
        # otherwise they hang around from previous tests. A fresh
        # temporary file is created for each test.
        self.tmpfile = tempfile.NamedTemporaryFile()
        self.command = FFprobeCommand(
            input_options=["-i", self.tmpfile.name], output_options=[])
        self.expected_executable = shutil.which("ffprobe")
        self.expected_base_options = [
            "-loglevel", "error",
            "-show_entries", "format:stream",
            "-print_format", "json",
        ]
        self.expected_input_options = ["-i", self.tmpfile.name]
        self.expected_filter_options = []
        self.expected_output_options = []

def tearDown(self):
        """Clean up after test."""
        self.tmpfile.close()
        self.command = None
    
    def test_last_modified(self):
        """Test that last modified time of temp file matches."""
        self.assertEqual(
            self.command.last_modified,
            Path(self.tmpfile.name).stat().st_mtime)

# get_entries()?

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Show notes View shell_command/test_shell_command.py 100644 → 0
import unittest from shell_command import ShellCommand from shell_command.shared_tests import ShellCommandSharedTestCase class ShellCommandTestCase(ShellCommandSharedTestCase): """Test the ShellCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set to # [] otherwise they hang around from previous tests. self.command = ShellCommand(input_options=[], output_options=[]) self.expected_executable = "" self.expected_base_options = [] self.expected_input_options = [] self.expected_filter_options = [] self.expected_output_options = [] def tearDown(self): """Clean up after test.""" self.command = None def test_shellquote(self): """Test shell quoting (static method).""" test_data = ( (None, None, "None ⇒ None"), ("", "", "(empty string) ⇒ (empty string)"), (" ", '" "', '␢ ⇒ " "'), (" ", '" "', '␢␢␢␢␢ ⇒ " "'), ("foobar", "foobar", "foobar ⇒ foobar"), ("foo bar", '"foo bar"', 'foo bar ⇒ "foo bar"'), ('"foobar"', '\'"foobar"\'', '"foobar" ⇒ \'"foobar"\''), ("'foobar'", "'foobar'", "'foobar' ⇒ 'foobar'"), ("foo 'bar'", '"foo \'bar\'"', "foo 'bar' ⇒ \"foo 'bar'\""), ('foo"bar', '\'foo"bar\'', 'foo"bar ⇒ \'foo"bar\''), ("foo.bar", '"foo.bar"', 'foo.bar ⇒ "foo.bar"'), ("foo(bar)", '"foo(bar)"', 'foo(bar) ⇒ "foo(bar)"'), ("[foobar]", '"[foobar]"', '[foobar] ⇒ "[foobar]"'), ("foo[bar", '"foo[bar"', 'foo[bar ⇒ "foo[bar"'), ("/foo/bar", "/foo/bar", "/foo/bar ⇒ /foo/bar"), ("-f", "-f", "-f ⇒ -f"), ("--foobar", "--foobar", "--foobar ⇒ --foobar"), ("(", r"\(", r"( ⇒ \("), (")", r"\)", r"( ⇒ \)"), ("'", '"\'"', '\' ⇒ "\'"'), ) for original, expected, description in test_data: with self.subTest(msg=description): self.assertEqual(ShellCommand.shellquote(original), expected) def test_append_input_options(self): """Test appending to input options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.input_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["foo", "bar"], '["bar"] ⇒ ["foo", "bar"]'), (["baz", 42], ["foo", "bar", "baz", 42], '["baz", 42] ⇒ ["foo", "bar", "baz", 42]'), ) for appended, expected, description in test_data: with self.subTest(msg="appending {}".format(description)): self.command.append_input_options(appended) self.assertEqual(self.command.input_options, expected) def test_prepend_input_options(self): """Test prepending to input options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.input_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["bar", "foo"], '["bar"] ⇒ ["bar", "foo"]'), (["baz", 42], ["baz", 42, "bar", "foo"], '["baz", 42] ⇒ ["baz", 42, "bar", "foo"]'), ) for prepended, expected, description in test_data: with self.subTest(msg="prepending {}".format(description)): self.command.prepend_input_options(prepended) self.assertEqual(self.command.input_options, expected) def test_append_output_options(self): """Test appending to output options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.output_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["foo", "bar"], '["bar"] ⇒ ["foo", "bar"]'), (["baz", 42], ["foo", "bar", "baz", 42], '["baz", 42] ⇒ ["foo", "bar", "baz", 42]'), ) for appended, expected, description in test_data: with self.subTest(msg="appending {}".format(description)): self.command.append_output_options(appended) self.assertEqual(self.command.output_options, expected) def test_prepend_output_options(self): """Test prepending to output options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.output_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["bar", "foo"], '["bar"] ⇒ ["bar", "foo"]'), (["baz", 42], ["baz", 42, "bar", "foo"], '["baz", 42] ⇒ ["baz", 42, "bar", "foo"]'), ) for prepended, expected, description in test_data: with self.subTest(msg="prepending {}".format(description)): self.command.prepend_output_options(prepended) self.assertEqual(self.command.output_options, expected) def test_process_pattern(self): """ Test pattern processing.""" # True on EOF (0) with self.subTest(msg="returns True on EOF"): self.assertTrue(self.command.process_pattern(0)) # False on anything else for i in (x for x in range(-1000, 1001) if x is not 0): with self.subTest(msg="returns False on {}".format(i)): self.assertFalse(self.command.process_pattern(i)) # The following two will require mocking of pexpect? def test_run(self): """Test running of subprocess.""" pass def test_get_output(self): """Test getting output from subprocess.""" pass # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Show notes View

shell_command/test_shell_command.py 100644 → 0

import unittest

from shell_command import ShellCommand
from shell_command.shared_tests import ShellCommandSharedTestCase

class ShellCommandTestCase(ShellCommandSharedTestCase):
    """Test the ShellCommand class."""

def tearDown(self):
        """Clean up after test."""
        self.command = None

def test_shellquote(self):
        """Test shell quoting (static method)."""
        test_data = (
            (None, None, "None ⇒ None"),
            ("", "", "(empty string) ⇒ (empty string)"),
            (" ", '" "', '␢ ⇒ " "'),
            ("     ", '"     "', '␢␢␢␢␢ ⇒ "     "'),
            ("foobar", "foobar", "foobar ⇒ foobar"),
            ("foo bar", '"foo bar"', 'foo bar ⇒ "foo bar"'),
            ('"foobar"', '\'"foobar"\'', '"foobar" ⇒ \'"foobar"\''),
            ("'foobar'", "'foobar'", "'foobar' ⇒ 'foobar'"),
            ("foo 'bar'", '"foo \'bar\'"', "foo 'bar' ⇒ \"foo 'bar'\""),
            ('foo"bar', '\'foo"bar\'', 'foo"bar ⇒ \'foo"bar\''),
            ("foo.bar", '"foo.bar"', 'foo.bar ⇒ "foo.bar"'),
            ("foo(bar)", '"foo(bar)"', 'foo(bar) ⇒ "foo(bar)"'),
            ("[foobar]", '"[foobar]"', '[foobar] ⇒ "[foobar]"'),
            ("foo[bar", '"foo[bar"', 'foo[bar ⇒ "foo[bar"'),
            ("/foo/bar", "/foo/bar", "/foo/bar ⇒ /foo/bar"),
            ("-f", "-f", "-f ⇒ -f"),
            ("--foobar", "--foobar", "--foobar ⇒ --foobar"),
            ("(", r"\(", r"( ⇒ \("),
            (")", r"\)", r"( ⇒ \)"),
            ("'", '"\'"', '\' ⇒ "\'"'),
        )
        for original, expected, description in test_data:
            with self.subTest(msg=description):
                self.assertEqual(ShellCommand.shellquote(original), expected)

def test_append_input_options(self):
        """Test appending to input options."""
        with self.subTest(msg="should initially be []"):
            self.assertEqual(self.command.input_options, [])
        test_data = (
            ([], [], "[] ⇒ []"),
            (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'),
            (["bar"], ["foo", "bar"], '["bar"] ⇒ ["foo", "bar"]'),
            (["baz", 42], ["foo", "bar", "baz", 42],
             '["baz", 42] ⇒ ["foo", "bar", "baz", 42]'),
        )
        for appended, expected, description in test_data:
            with self.subTest(msg="appending {}".format(description)):
                self.command.append_input_options(appended)
                self.assertEqual(self.command.input_options, expected)

def test_prepend_input_options(self):
        """Test prepending to input options."""
        with self.subTest(msg="should initially be []"):
            self.assertEqual(self.command.input_options, [])
        test_data = (
            ([], [], "[] ⇒ []"),
            (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'),
            (["bar"], ["bar", "foo"], '["bar"] ⇒ ["bar", "foo"]'),
            (["baz", 42], ["baz", 42, "bar", "foo"],
             '["baz", 42] ⇒ ["baz", 42, "bar", "foo"]'),
        )
        for prepended, expected, description in test_data:
            with self.subTest(msg="prepending {}".format(description)):
                self.command.prepend_input_options(prepended)
                self.assertEqual(self.command.input_options, expected)

def test_append_output_options(self):
        """Test appending to output options."""
        with self.subTest(msg="should initially be []"):
            self.assertEqual(self.command.output_options, [])
        test_data = (
            ([], [], "[] ⇒ []"),
            (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'),
            (["bar"], ["foo", "bar"], '["bar"] ⇒ ["foo", "bar"]'),
            (["baz", 42], ["foo", "bar", "baz", 42],
             '["baz", 42] ⇒ ["foo", "bar", "baz", 42]'),
        )
        for appended, expected, description in test_data:
            with self.subTest(msg="appending {}".format(description)):
                self.command.append_output_options(appended)
                self.assertEqual(self.command.output_options, expected)

def test_prepend_output_options(self):
        """Test prepending to output options."""
        with self.subTest(msg="should initially be []"):
            self.assertEqual(self.command.output_options, [])
        test_data = (
            ([], [], "[] ⇒ []"),
            (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'),
            (["bar"], ["bar", "foo"], '["bar"] ⇒ ["bar", "foo"]'),
            (["baz", 42], ["baz", 42, "bar", "foo"],
             '["baz", 42] ⇒ ["baz", 42, "bar", "foo"]'),
        )
        for prepended, expected, description in test_data:
            with self.subTest(msg="prepending {}".format(description)):
                self.command.prepend_output_options(prepended)
                self.assertEqual(self.command.output_options, expected)

def test_process_pattern(self):
        """ Test pattern processing."""
        # True on EOF (0)
        with self.subTest(msg="returns True on EOF"):
            self.assertTrue(self.command.process_pattern(0))
        # False on anything else
        for i in (x for x in range(-1000, 1001) if x is not 0):
            with self.subTest(msg="returns False on {}".format(i)):
                self.assertFalse(self.command.process_pattern(i))

# The following two will require mocking of pexpect?
    def test_run(self):
        """Test running of subprocess."""
        pass

def test_get_output(self):
        """Test getting output from subprocess."""
        pass

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Ignore Space Show notes View shell_command/tests/__init__.py 0 → 100644

Ignore Space Show notes View shell_command/tests/shared_tests.py 0 → 100644
import unittest from shell_command import ShellCommand class ShellCommandSharedTestCase(unittest.TestCase): """Shared tests for ShellCommand and its subclasses.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set to # [] otherwise they hang around from previous tests. self.command = ShellCommand(input_options=[], output_options=[]) self.expected_executable = "" self.expected_base_options = [] self.expected_input_options = [] self.expected_filter_options = [] self.expected_output_options = [] def tearDown(self): """Clean up after test.""" self.command = None def test_base_options(self): """Test that base options match expected.""" self.assertEqual( self.command._base_options, self.expected_base_options) def test_input_options(self): """Test that input options match expected.""" self.assertEqual( self.command.input_options, self.expected_input_options) def test_output_options(self): """Test that output options match expected.""" self.assertEqual( self.command.output_options, self.expected_output_options) def test_executable_string(self): """Test that executable path matches expected.""" with self.subTest(msg="unquoted paths match"): self.assertEqual( self.command.executable_string(quote=False), self.expected_executable) with self.subTest(msg="unquoted paths match"): # Note: don't explicitly specify quoted value, because # the executable path will vary across different systems. self.assertEqual( self.command.executable_string(quote=True), ShellCommand.shellquote(self.expected_executable)) def test_argument_string(self): """Test that argument string matches expected.""" args = (self.expected_base_options + self.expected_input_options + self.expected_filter_options + self.expected_output_options) with self.subTest(msg="unquoted agruments match"): self.assertEqual( self.command.argument_string(quote=False), " ".join(args)) with self.subTest(msg="quoted agruments match"): self.assertEqual( self.command.argument_string(quote=True), " ".join([ShellCommand.shellquote(a) for a in args])) def test_argument_list(self): """Test that argument list matches expected.""" self.assertEqual(self.command.argument_list(), self.expected_base_options + self.expected_input_options + self.expected_filter_options + self.expected_output_options) def test_command_string(self): """Test that command string matches expected.""" args = (self.expected_base_options + self.expected_input_options + self.expected_filter_options + self.expected_output_options) expected_cmd_unquoted = ( "{exe} {arg}".format(exe=self.expected_executable, arg=" ".join(args)) ) expected_cmd_quoted = ( '{exe} {arg}'.format( exe=ShellCommand.shellquote(self.expected_executable), arg=" ".join([ShellCommand.shellquote(a) for a in args])) ) with self.subTest(msg="unquoted command string matches"): self.assertEqual( self.command.command_string(quote=False), expected_cmd_unquoted) with self.subTest(msg="quoted command string matches"): self.assertEqual( self.command.command_string(quote=True), expected_cmd_quoted)

Ignore Space Show notes View

shell_command/tests/shared_tests.py 0 → 100644

import unittest

from shell_command import ShellCommand

class ShellCommandSharedTestCase(unittest.TestCase):
    """Shared tests for ShellCommand and its subclasses."""

def tearDown(self):
        """Clean up after test."""
        self.command = None

Ignore Space Show notes View shell_command/tests/test_convert_command.py 0 → 100644
import shutil import unittest from shell_command import ConvertCommand from shell_command.tests.shared_tests import ShellCommandSharedTestCase class ConvertCommandTestCase(ShellCommandSharedTestCase): """Test the ConvertCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. self.command = ConvertCommand( input_options=["in.pdf[12]"], output_options=["out.png"]) self.expected_executable = shutil.which("convert") self.expected_base_options = [ "-size", "2048x1536", "-density", "600", "xc:dimgrey", "null:", "(" ] self.expected_input_options = [ "in.pdf[12]", "-resize", "2048x1536", "-background", "white", "-alpha", "remove", "-type", "truecolor", "-define", "colorspace:auto-grayscale=off", ] self.expected_filter_options = [] self.expected_output_options = [ ")", "-gravity", "center", "-layers", "composite", "-flatten", "out.png", ] def tearDown(self): """Clean up after test.""" self.command = None # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Ignore Space Show notes View

shell_command/tests/test_convert_command.py 0 → 100644

import shutil
import unittest

from shell_command import ConvertCommand
from shell_command.tests.shared_tests import ShellCommandSharedTestCase

class ConvertCommandTestCase(ShellCommandSharedTestCase):
    """Test the ConvertCommand class."""

def tearDown(self):
        """Clean up after test."""
        self.command = None

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Ignore Space Show notes View shell_command/tests/test_ffmpeg_command.py 0 → 100644
import shutil from pathlib import Path import tempfile import unittest from shell_command import FFmpegCommand from shell_command.tests.shared_tests import ShellCommandSharedTestCase class FFmpegCommandTestCase(ShellCommandSharedTestCase): """Test the FFmpegCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. self.command = FFmpegCommand( input_options=["-i", "in.mov"], output_options=["out.mov"]) self.expected_executable = shutil.which("ffmpeg") self.expected_base_options = ["-y", "-nostdin",] self.expected_input_options = ["-i", "in.mov"] self.expected_filter_options = [] self.expected_output_options = ["out.mov"] def tearDown(self): """Clean up after test.""" self.command = None # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Ignore Space Show notes View

shell_command/tests/test_ffmpeg_command.py 0 → 100644

import shutil
from pathlib import Path
import tempfile
import unittest

from shell_command import FFmpegCommand
from shell_command.tests.shared_tests import ShellCommandSharedTestCase

class FFmpegCommandTestCase(ShellCommandSharedTestCase):
    """Test the FFmpegCommand class."""

def tearDown(self):
        """Clean up after test."""
        self.command = None

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Ignore Space Show notes View shell_command/tests/test_ffmpeg_concat_command.py 0 → 100644
from datetime import timedelta from pathlib import Path import shutil import tempfile import unittest from unittest.mock import MagicMock from segment import Segment, AudioSegment, VideoSegment from shell_command import FFmpegConcatCommand from shell_command.tests.shared_tests import ShellCommandSharedTestCase class FFmpegConcatCommandTestCase(ShellCommandSharedTestCase): """Test the FFmpegConcatCommand class.""" NORMALISATION_FILTER = "[aconc] dynaudnorm=r=0.25:f=10:b=y [anorm]" # What about testing different permutations of audio and video? def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. self.command = FFmpegConcatCommand( input_options=["-i", "in.mov"], output_options=["out.mov"], has_video=True, has_audio=True, quiet=True) self.expected_executable = shutil.which("ffmpeg") self.expected_base_options = ["-y", "-nostdin",] self.expected_input_options = ["-i", "in.mov"] self.expected_filter_options = ["-filter_complex", ""] self.expected_output_options = [ "-codec:a", self.command.audio_codec, "-ac", "1", "-map", "[anorm]", "-codec:v", self.command.video_codec, "-pix_fmt", "yuv420p", "-map", "[vconc]", "out.mov" ] def tearDown(self): """Clean up after test.""" self.command = None def test_append_filter(self): """Test appending to the filter list.""" test_data = ( ("", [], "append empty filter"), ("normal_filter", ["normal_filter"], "append normal filter"), ) for appended, expected, description in test_data: with self.subTest(msg=description): self.command.append_filter(appended) self.assertEqual(self.command.filters, expected) def test_append_normalisation_filter(self): """Test appending a normalisation filter.""" filters = [self.NORMALISATION_FILTER] self.command.append_normalisation_filter() self.assertEqual(self.command.filters, filters) def test_append_concat_filter(self): """Test appending various concat filters.""" test_data = ( ("a", "audio"), ("v", "video"), ("f", "frame (should be ignored)"), ) expected = [] for frame_type, description in test_data: for num_segments in range(0, 3): segments = None if frame_type == "a": segments = num_segments * [AudioSegment( file="file.in", punch_in=timedelta(), punch_out=timedelta(seconds=20), input_stream=0)] elif frame_type == "v": segments = num_segments * [VideoSegment( file="file.in", punch_in=timedelta(), punch_out=timedelta(seconds=20), input_stream=0)] elif frame_type == "f": # Frame segments should be ignored by # append_concat_filter() regardless. segments = [] else: raise TypeError self.command.append_concat_filter( frame_type=frame_type, segments=segments) if frame_type not in ["a", "v"]: # Ignore frame segments. pass elif num_segments > 1: expected.append( "{inspecs} concat=n={n}:v={v}:a={a} [{t}conc]".format( inspecs=" ".join([s.output_stream_specifier() for s in segments]), n=num_segments, v=int(frame_type == "v"), a=int(frame_type == "a"), t=frame_type) ) elif num_segments == 1: expected.append( "{inspec} {a}null [{t}conc]".format( inspec=segments[0].output_stream_specifier(), a=frame_type if frame_type == "a" else "", t=frame_type) ) with self.subTest( msg="{d}: {n}".format(d=description, n=num_segments)): self.assertEqual(self.command.filters, expected) def test_build_complex_filter(self): self.command.append_normalisation_filter() self.assertEqual( self.command.build_complex_filter(), self.NORMALISATION_FILTER) test_data = ( ("", self.NORMALISATION_FILTER, "append empty filter"), ("normal_filter", "{n};normal_filter".format(n=self.NORMALISATION_FILTER), "append normal filter"), ) for appended, expected, description in test_data: with self.subTest(msg=description): self.command.append_filter(appended) self.assertEqual(self.command.build_complex_filter(), expected) # process_pattern() updates the internal ProgressBar object. # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Ignore Space Show notes View

shell_command/tests/test_ffmpeg_concat_command.py 0 → 100644

from datetime import timedelta
from pathlib import Path
import shutil
import tempfile
import unittest
from unittest.mock import MagicMock

from segment import Segment, AudioSegment, VideoSegment
from shell_command import FFmpegConcatCommand
from shell_command.tests.shared_tests import ShellCommandSharedTestCase

class FFmpegConcatCommandTestCase(ShellCommandSharedTestCase):
    """Test the FFmpegConcatCommand class."""

NORMALISATION_FILTER = "[aconc] dynaudnorm=r=0.25:f=10:b=y [anorm]"

# process_pattern() updates the internal ProgressBar object.

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Ignore Space Show notes View shell_command/tests/test_ffprobe_command.py 0 → 100644
import shutil from pathlib import Path import tempfile import unittest from shell_command import FFprobeCommand from shell_command.tests.shared_tests import ShellCommandSharedTestCase class FFprobeCommandTestCase(ShellCommandSharedTestCase): """Test the FFprobeCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set, # otherwise they hang around from previous tests. A fresh # temporary file is created for each test. self.tmpfile = tempfile.NamedTemporaryFile() self.command = FFprobeCommand( input_options=["-i", self.tmpfile.name], output_options=[]) self.expected_executable = shutil.which("ffprobe") self.expected_base_options = [ "-loglevel", "error", "-show_entries", "format:stream", "-print_format", "json", ] self.expected_input_options = ["-i", self.tmpfile.name] self.expected_filter_options = [] self.expected_output_options = [] def tearDown(self): """Clean up after test.""" self.tmpfile.close() self.command = None def test_last_modified(self): """Test that last modified time of temp file matches.""" self.assertEqual( self.command.last_modified, Path(self.tmpfile.name).stat().st_mtime) # get_entries()? # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Ignore Space Show notes View

shell_command/tests/test_ffprobe_command.py 0 → 100644

import shutil
from pathlib import Path
import tempfile
import unittest

from shell_command import FFprobeCommand
from shell_command.tests.shared_tests import ShellCommandSharedTestCase

class FFprobeCommandTestCase(ShellCommandSharedTestCase):
    """Test the FFprobeCommand class."""

# get_entries()?

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Ignore Space Show notes View shell_command/tests/test_shell_command.py 0 → 100644
import unittest from shell_command import ShellCommand from shell_command.tests.shared_tests import ShellCommandSharedTestCase class ShellCommandTestCase(ShellCommandSharedTestCase): """Test the ShellCommand class.""" def setUp(self): """Set up for test.""" # Make sure the input and output options are explicitly set to # [] otherwise they hang around from previous tests. self.command = ShellCommand(input_options=[], output_options=[]) self.expected_executable = "" self.expected_base_options = [] self.expected_input_options = [] self.expected_filter_options = [] self.expected_output_options = [] def tearDown(self): """Clean up after test.""" self.command = None def test_shellquote(self): """Test shell quoting (static method).""" test_data = ( (None, None, "None ⇒ None"), ("", "", "(empty string) ⇒ (empty string)"), (" ", '" "', '␢ ⇒ " "'), (" ", '" "', '␢␢␢␢␢ ⇒ " "'), ("foobar", "foobar", "foobar ⇒ foobar"), ("foo bar", '"foo bar"', 'foo bar ⇒ "foo bar"'), ('"foobar"', '\'"foobar"\'', '"foobar" ⇒ \'"foobar"\''), ("'foobar'", "'foobar'", "'foobar' ⇒ 'foobar'"), ("foo 'bar'", '"foo \'bar\'"', "foo 'bar' ⇒ \"foo 'bar'\""), ('foo"bar', '\'foo"bar\'', 'foo"bar ⇒ \'foo"bar\''), ("foo.bar", '"foo.bar"', 'foo.bar ⇒ "foo.bar"'), ("foo(bar)", '"foo(bar)"', 'foo(bar) ⇒ "foo(bar)"'), ("[foobar]", '"[foobar]"', '[foobar] ⇒ "[foobar]"'), ("foo[bar", '"foo[bar"', 'foo[bar ⇒ "foo[bar"'), ("/foo/bar", "/foo/bar", "/foo/bar ⇒ /foo/bar"), ("-f", "-f", "-f ⇒ -f"), ("--foobar", "--foobar", "--foobar ⇒ --foobar"), ("(", r"\(", r"( ⇒ \("), (")", r"\)", r"( ⇒ \)"), ("'", '"\'"', '\' ⇒ "\'"'), ) for original, expected, description in test_data: with self.subTest(msg=description): self.assertEqual(ShellCommand.shellquote(original), expected) def test_append_input_options(self): """Test appending to input options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.input_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["foo", "bar"], '["bar"] ⇒ ["foo", "bar"]'), (["baz", 42], ["foo", "bar", "baz", 42], '["baz", 42] ⇒ ["foo", "bar", "baz", 42]'), ) for appended, expected, description in test_data: with self.subTest(msg="appending {}".format(description)): self.command.append_input_options(appended) self.assertEqual(self.command.input_options, expected) def test_prepend_input_options(self): """Test prepending to input options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.input_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["bar", "foo"], '["bar"] ⇒ ["bar", "foo"]'), (["baz", 42], ["baz", 42, "bar", "foo"], '["baz", 42] ⇒ ["baz", 42, "bar", "foo"]'), ) for prepended, expected, description in test_data: with self.subTest(msg="prepending {}".format(description)): self.command.prepend_input_options(prepended) self.assertEqual(self.command.input_options, expected) def test_append_output_options(self): """Test appending to output options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.output_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["foo", "bar"], '["bar"] ⇒ ["foo", "bar"]'), (["baz", 42], ["foo", "bar", "baz", 42], '["baz", 42] ⇒ ["foo", "bar", "baz", 42]'), ) for appended, expected, description in test_data: with self.subTest(msg="appending {}".format(description)): self.command.append_output_options(appended) self.assertEqual(self.command.output_options, expected) def test_prepend_output_options(self): """Test prepending to output options.""" with self.subTest(msg="should initially be []"): self.assertEqual(self.command.output_options, []) test_data = ( ([], [], "[] ⇒ []"), (["foo"], ["foo"], '["foo"] ⇒ ["foo"]'), (["bar"], ["bar", "foo"], '["bar"] ⇒ ["bar", "foo"]'), (["baz", 42], ["baz", 42, "bar", "foo"], '["baz", 42] ⇒ ["baz", 42, "bar", "foo"]'), ) for prepended, expected, description in test_data: with self.subTest(msg="prepending {}".format(description)): self.command.prepend_output_options(prepended) self.assertEqual(self.command.output_options, expected) def test_process_pattern(self): """ Test pattern processing.""" # True on EOF (0) with self.subTest(msg="returns True on EOF"): self.assertTrue(self.command.process_pattern(0)) # False on anything else for i in (x for x in range(-1000, 1001) if x is not 0): with self.subTest(msg="returns False on {}".format(i)): self.assertFalse(self.command.process_pattern(i)) # The following two will require mocking of pexpect? def test_run(self): """Test running of subprocess.""" pass def test_get_output(self): """Test getting output from subprocess.""" pass # Remove ShellCommandSharedTestCase from the namespace so we don't run # the shared tests twice. See <https://stackoverflow.com/a/22836015>. del(ShellCommandSharedTestCase)

Ignore Space Show notes View

shell_command/tests/test_shell_command.py 0 → 100644

import unittest

from shell_command import ShellCommand
from shell_command.tests.shared_tests import ShellCommandSharedTestCase

class ShellCommandTestCase(ShellCommandSharedTestCase):
    """Test the ShellCommand class."""

def tearDown(self):
        """Clean up after test."""
        self.command = None

# The following two will require mocking of pexpect?
    def test_run(self):
        """Test running of subprocess."""
        pass

def test_get_output(self):
        """Test getting output from subprocess."""
        pass

# Remove ShellCommandSharedTestCase from the namespace so we don't run
# the shared tests twice. See <https://stackoverflow.com/a/22836015>.
del(ShellCommandSharedTestCase)

Show line notes below