tests for howler

kyclark · kyclark · commit 04d2eca887f3 · 2019-05-17T13:16:27.000-07:00
diff --git a/howler/Makefile b/howler/Makefile
@@ -0,0 +1,7 @@
+.PHONY: pdf test
+
+pdf:
+	pandoc README.md -o README.pdf
+
+test:
+	pytest -v test.py
diff --git a/howler/README.md b/howler/README.md
@@ -1,3 +1,27 @@
 # Howler
 
 Write a Python program `howler.py` that will uppercase all the text from the command line or from a file.
+
+````
+$ ./howler.py
+usage: howler.py [-h] [-o str] STR
+howler.py: error: the following arguments are required: STR
+$ ./howler.py -h
+usage: howler.py [-h] [-o str] STR
+
+Howler (upper-case input)
+
+positional arguments:
+  STR                   Input string or file
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -o str, --outfile str
+                        Output filename (default: )
+````
+
+# Skills
+
+* Reading text from command line or a file
+* Transforming text
+* Write to a file or STDOUT
diff --git a/howler/howler.py b/howler/howler.py
diff --git a/howler/mk-test-out.sh b/howler/mk-test-out.sh
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+set -u
+
+PRG="./howler.py"
+IN_DIR="../inputs"
+OUT_DIR="test-outs"
+
+[[ ! -d "$OUT_DIR" ]] && mkdir -p "$OUT_DIR"
+
+for FILE in sonnet-29.txt the-bustle.txt preamble.txt; do
+    IN_FILE="$IN_DIR/$FILE"
+    OUT_FILE="$OUT_DIR/$FILE"
+
+    if [[ -f "$IN_FILE" ]]; then
+        $PRG "$IN_FILE" -o "$OUT_FILE"
+    fi
+done
+
+echo "Done."
diff --git a/howler/solution.py b/howler/solution.py
@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+"""
+Author : kyclark
+Date   : 2019-05-17
+Purpose: Howler
+"""
+
+import argparse
+import os
+import sys
+
+
+# --------------------------------------------------
+def get_args():
+    """get command-line arguments"""
+    parser = argparse.ArgumentParser(
+        description='Howler (upper-case input)',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+
+    parser.add_argument('text', metavar='STR', help='Input string or file')
+
+    parser.add_argument(
+        '-o',
+        '--outfile',
+        help='Output filename',
+        metavar='str',
+        type=str,
+        default='')
+
+    return parser.parse_args()
+
+
+# --------------------------------------------------
+def warn(msg):
+    """Print a message to STDERR"""
+    print(msg, file=sys.stderr)
+
+
+# --------------------------------------------------
+def die(msg='Something bad happened'):
+    """warn() and exit with error"""
+    warn(msg)
+    sys.exit(1)
+
+
+# --------------------------------------------------
+def main():
+    """Make a jazz noise here"""
+    args = get_args()
+    text = args.text
+    out_file = args.outfile
+
+    if os.path.isfile(text):
+        text = open(text).read()
+
+    out_fh = open(out_file, 'wt') if out_file else sys.stdout
+    out_fh.write(text.upper() + '\n')
+
+
+# --------------------------------------------------
+if __name__ == '__main__':
+    main()
diff --git a/howler/test-outs/preamble.txt b/howler/test-outs/preamble.txt
@@ -0,0 +1,7 @@
+WHEN, IN THE COURSE OF HUMAN EVENTS, IT BECOMES NECESSARY FOR ONE PEOPLE TO 
+DISSOLVE THE POLITICAL BANDS WHICH HAVE CONNECTED THEM WITH ANOTHER, AND TO 
+ASSUME AMONG THE POWERS OF THE EARTH, THE SEPARATE AND EQUAL STATION TO 
+WHICH THE LAWS OF NATURE AND OF NATURE'S GOD ENTITLE THEM, A DECENT RESPECT 
+TO THE OPINIONS OF MANKIND REQUIRES THAT THEY SHOULD DECLARE THE CAUSES 
+WHICH IMPEL THEM TO THE SEPARATION.
+
diff --git a/howler/test-outs/sonnet-29.txt b/howler/test-outs/sonnet-29.txt
@@ -0,0 +1,18 @@
+SONNET 29
+WILLIAM SHAKESPEARE
+
+WHEN, IN DISGRACE WITH FORTUNE AND MEN’S EYES,
+I ALL ALONE BEWEEP MY OUTCAST STATE,
+AND TROUBLE DEAF HEAVEN WITH MY BOOTLESS CRIES,
+AND LOOK UPON MYSELF AND CURSE MY FATE,
+WISHING ME LIKE TO ONE MORE RICH IN HOPE,
+FEATURED LIKE HIM, LIKE HIM WITH FRIENDS POSSESSED,
+DESIRING THIS MAN’S ART AND THAT MAN’S SCOPE,
+WITH WHAT I MOST ENJOY CONTENTED LEAST;
+YET IN THESE THOUGHTS MYSELF ALMOST DESPISING,
+HAPLY I THINK ON THEE, AND THEN MY STATE,
+(LIKE TO THE LARK AT BREAK OF DAY ARISING
+FROM SULLEN EARTH) SINGS HYMNS AT HEAVEN’S GATE;
+FOR THY SWEET LOVE REMEMBERED SUCH WEALTH BRINGS
+THAT THEN I SCORN TO CHANGE MY STATE WITH KINGS.
+
diff --git a/howler/test-outs/the-bustle.txt b/howler/test-outs/the-bustle.txt
@@ -0,0 +1,10 @@
+THE BUSTLE IN A HOUSE
+THE MORNING AFTER DEATH
+IS SOLEMNEST OF INDUSTRIES
+ENACTED UPON EARTH,—    
+  
+THE SWEEPING UP THE HEART,
+AND PUTTING LOVE AWAY
+WE SHALL NOT WANT TO USE AGAIN
+UNTIL ETERNITY.
+
diff --git a/howler/test.py b/howler/test.py
@@ -0,0 +1,89 @@
+#!/usr/bin/env python3
+"""tests for howler.py"""
+
+import os
+import re
+import random
+import string
+from subprocess import getstatusoutput, getoutput
+
+prg = './howler.py'
+
+
+# --------------------------------------------------
+def random_string():
+    """generate a random string"""
+
+    k = random.randint(5, 10)
+    return ''.join(random.choices(string.ascii_letters + string.digits, k=k))
+
+
+# --------------------------------------------------
+def out_flag():
+    """Either -o or --outfile"""
+
+    return '-o' if random.randint(0, 1) else '--outfile'
+
+
+# --------------------------------------------------
+def test_usage():
+    """usage"""
+
+    for flag in ['-h', '--help']:
+        rv, out = getstatusoutput('{} {}'.format(prg, flag))
+        assert rv == 0
+        assert re.match("usage", out, re.IGNORECASE)
+
+
+# --------------------------------------------------
+def test_text_stdout():
+    """Test STDIN/STDOUT"""
+
+    out = getoutput('{} "foo bar baz"'.format(prg))
+    expected = 'FOO BAR BAZ'
+    assert out.strip() == expected
+
+
+# --------------------------------------------------
+def test_text_outfile():
+    """Test STDIN/outfile"""
+
+    out_file = random_string()
+
+    if os.path.isfile(out_file):
+        os.remove(out_file)
+
+    try:
+        out = getoutput('{} {} {} "foo bar baz"'.format(
+            prg, out_flag(), out_file))
+        assert out.strip() == ''
+        assert os.path.isfile(out_file)
+        text = open(out_file).read().rstrip()
+        assert text == 'FOO BAR BAZ'
+    finally:
+        if os.path.isfile(out_file):
+            os.remove(out_file)
+
+
+# --------------------------------------------------
+def test_file():
+    """Test file in/out"""
+
+    for expected_file in os.listdir('test-outs'):
+        try:
+            out_file = random_string()
+            if os.path.isfile(out_file):
+                os.remove(out_file)
+
+            basename = os.path.basename(expected_file)
+            in_file = os.path.join('../inputs', basename)
+            out = getoutput('{} {} {} {}'.format(prg, out_flag(), out_file,
+                                                 in_file))
+            assert out.strip() == ''
+            produced = open(out_file).read().rstrip()
+            expected = open(os.path.join('test-outs',
+                                         expected_file)).read().strip()
+            assert expected == produced
+        finally:
+            if os.path.isfile(out_file):
+                os.remove(out_file)
diff --git a/howler/the-bustle.txt b/howler/the-bustle.txt
