Merge pull request #11 from dave3d/AddTesting

WIP: initial testing checkin

Author: dave3d

.github/workflows/python-app.yml

@@ -0,0 +1,37 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python testing
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install -e .
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings.
+        flake8 . --count --exit-zero --max-complexity=10 --statistics
+    - name: Run tests
+      run: |
+        python -m unittest discover -s tests

README.md

@@ -1,31 +1,34 @@
 # SimpleITKSpellChecking
 
+![python testing](https://github.com/SimpleITK/SimpleITKSpellChecking/actions/workflows/python-app.yml/badge.svg)
+
+
 A script that automatically spell checks the comments of a code base.
 It is intended to be run on the SimpleITK and ITK code bases.
 
 Here is how it is typically run:
 
     python codespell.py --exclude Ancillary $SIMPLEITK_SOURCE_DIR/Code
 
-This will recursively find all the '.h' files in a directory, extract
-the C/C++ comments from the code and run a spell checker on them.
-The '--exclude' flag tells the script to ignore any file that has
-'Ancillary' in it's full path name.  This flag will accept any
+This command will recursively find all the '.h' files in a directory,
+extract the C/C++ comments from the code, and run a spell checker on them.
+The **'--exclude'** flag tells the script to ignore any file that has
+'Ancillary' in its full path name.  This flag will accept any
 regular expression.
 
-In addition to pyenchant's English dictionary, we use the words in 
-**additional_dictionary.txt**.  These are proper names and technical
-terms harvest by hand from SimpleITK and ITK.
+In addition to pyenchant's English dictionary, we use the words in
+**additional_dictionary.txt**.  These words are proper names and
+technical terms harvest by hand from the SimpleITK and ITK code bases.
 
-In addition to checking each word against the dictionary, if a word
-fails, we try two additional checks.
+If a word is not found in the dictionaries, we try two additional checks.
 
-First, if the word starts with some know prefix, the prefix is removed 
-and the remaining word is checked.  The prefixes currently checked
-are 'sitk', 'itk', and 'vtk'.  Additional prefixes can be specified
-with the '--prefix' command line argument.
+1. If the word starts with some known prefix, the prefix is removed
+...and the remaining word is checked against the dictionary.  The prefixes
+...used by default are **'sitk'**, **'itk'**, and **'vtk'**.  Additional
+...prefixes can be specified with the **'--prefix'** command line argument.
 
-Second, we attempt to split the word by capitalization and check each
-sub-word.  This is an attempt to detect camel-case words such as
-'GetArrayFromImage', which would get split into 'Get', 'Array', 'From',
-and 'Image'.  Camel-case words are very commonly used for code elements.
+2. We attempt to split the word by capitalization and check each
+...sub-word against the dictionary.  This method is an attempt to detect
+...camel-case words such as 'GetArrayFromImage', which would get split into
+...'Get', 'Array', 'From', and 'Image'.  Camel-case words are very commonly
+...used for code elements.

tests/__init__.py

@@ -0,0 +1 @@
+# tests

tests/dict.txt

@@ -0,0 +1 @@
+TarHeels

tests/example.h

@@ -0,0 +1,29 @@
+
+
+// Mary had a little lamb
+//
+// Prefix test words:
+// sitkBanana
+// vtkApple
+// itkPineapple
+//
+// Camel case test word:
+// CamelCaseTestWord
+//
+// Prefix and camel case test word:
+// sitkWhiskeyTangoFoxtrot
+//
+// Dictionary test word:
+// BinaryFillholeImageFilter
+//
+// Additional dictionary test word:
+// TarHeels
+
+#include <stdio.h>
+
+int test_int;
+int hello_world() {
+  // Sup, bro?
+  print("Mmmm, pie.");
+}
+

tests/test_codespell.py

@@ -0,0 +1,33 @@
+import unittest
+import subprocess
+import os
+
+
+class TestCodespell(unittest.TestCase):
+    @classmethod
+    def setUpClass(self):
+        print("Setting up codespell tests")
+
+    @classmethod
+    def tearDownClass(cls):
+        print("Tearing down dicom2stl tests")
+
+    def test_codespell(self):
+        print("Codespell test")
+        cwd = os.getcwd()
+        print(cwd)
+        runresult = subprocess.run(
+            [
+                "python",
+                "codespell.py",
+                "--verbose",
+                "--dict",
+                "tests/dict.txt",
+                "tests/example.h"
+            ]
+        )
+        print("Return code:", runresult.returncode)
+        if runresult.returncode:
+            self.fail("codespell process returned bad code")
+
+