Initial commit

DEPENDENCIES setup:
* https://realpython.com/lessons/using-requirement-files

TEST + COVERAGE setup:
* https://realpython.com/python-testing/
* https://www.pythontutorial.net/python-unit-testing/python-unittest-coverage/

Author: Gonzalo Diaz

.github/workflows/python.yml

@@ -0,0 +1,46 @@
+name: Python
+
+on:
+  push:
+    branches: [ "main", "feature/*" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  LOG_LEVEL: WARN
+
+jobs:
+
+  build:
+    name: "Run CI"
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [
+          "windows-latest",
+          "ubuntu-latest",
+          "macOS-latest"
+        ]
+        python: ["3.10"]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Python
+      uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python }}
+
+    - name: Install
+      run: pip3 install --upgrade -r requirements.txt
+
+    - name: Test
+      run: |
+        python3 -m coverage run -m unittest discover -s src -p '*_test.py' --verbose
+
+    - name: Coverage
+      run: |
+        python3 -m coverage report
+
+    - name: Upload coverage reports to Codecov with GitHub Action
+      uses: codecov/codecov-action@v3

Makefile

@@ -9,13 +9,27 @@ list:
 dependencies:
 	pip3 install -r requirements.txt
 
-# upgrade:
-#   pip3 install --upgrade -r requirements.txt
+update:
+	pip3 freeze > requirements.txt
+
+upgrade:
+	pip3 install --upgrade -r requirements.txt
 
 test: dependencies
 	python3 -m unittest discover -s src -p '*_test.py'
 
+coverage: test
+	python3 -m coverage run -m unittest discover -s src -p '*_test.py' --verbose
+	python3 -m coverage report
+
+coverage/html: coverage
+	python3 -m coverage html
+
 clean:
 	pip3 freeze > unins ; pip3 uninstall -y -r unins ; rm unins
+	rm -fr .pytest_cache
+	rm -fr htmlcov
+	rm -fr src/__pycache__
+	rm .coverage
 
 all: test coverage

compose.yaml

@@ -0,0 +1,22 @@
+services:
+  projecteuler-py:
+    image: projecteuler-py:latest
+    build:
+      context: .
+      target: testing
+    environment:
+      _DEBUG: ${_DEBUG}
+    volumes:
+      - ./coverage:/app/coverage
+    profiles: ["testing"]
+
+  projecteuler-py-dev:
+    image: projecteuler-py:dev
+    build:
+      context: .
+      target: development
+    environment:
+      _DEBUG: ${_DEBUG}
+    volumes:
+      - ./:/app
+    profiles: ["development"]

requirements.txt

@@ -0,0 +1,9 @@
+attrs==22.1.0
+coverage==6.4.4
+iniconfig==1.1.1
+packaging==21.3
+pluggy==1.0.0
+py==1.11.0
+pyparsing==3.0.9
+pytest==7.1.2
+tomli==2.0.1

src/main_test.py

@@ -15,6 +15,3 @@ def test_split(self):
         # check that s.split fails when the separator is not a string
         with self.assertRaises(TypeError):
             s.split(2)
-
-if __name__ == '__main__':
-    unittest.main()