Merge pull request #1 from FireTail-io/feat-release-process

Feat release process

Author: rileyfiretail

.github/release-drafter.yml

@@ -0,0 +1,30 @@
+name-template: 'v$RESOLVED_VERSION Release'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: '🧰 Maintenance'
+    label: 'chore'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Changes
+  $CHANGES

.github/workflows/build.yml

@@ -0,0 +1,31 @@
+name: build process
+
+on:
+  push:
+    branches:
+      - main
+permissions:
+  id-token: write
+  contents: write
+  pull-requests: write
+jobs:
+  build-docker-image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: draft release
+        uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install Tox and any other packages
+        run: pip install tox
+      - name: Run Tox
+        # Run tox using the version of Python in `PATH`
+        run: tox -e py
+      - uses: actions/cache@v3
+        with:
+          path: ./coverage.xml  # Note that this path is not influenced by working-directory set in defaults, for example
+          key: coverage

.github/workflows/release.yml

@@ -3,7 +3,6 @@ name: Release
 on:
   release:
     types: [created]
-
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -13,6 +12,8 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: "3.x"
+      - name: Update version
+        run: sed -i "s/__version__ = .*/__version__ = '${{github.ref_name}}'/" */version.py
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

.github/workflows/test.yml

@@ -1,17 +1,12 @@
 name: Test
 
 on:
-  push:
-    branches:
-      - main
-      - master
   pull_request:
     branches:
       - main
-      - master
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -28,3 +23,23 @@ jobs:
       - name: Run Tox
         # Run tox using the version of Python in `PATH`
         run: tox -e py
+      - uses: actions/cache@v3
+        with:
+          path: ./coverage.xml  # Note that this path is not influenced by working-directory set in defaults, for example
+          key: coverage
+
+  finish-codecov:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/cache@v3
+        with:
+          path: ./coverage.xml # See the note below
+          key: coverage  # Must be the same key you specified in the first job
+      - uses: codecov/codecov-action@v3
+        with:
+          files: ./coverage.xml
+          flags: unittests # optional
+          token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+          fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)

firetail_lambda/__init__.py

@@ -1,6 +1,10 @@
-import base64, json, time
+import base64
+import json
+import time
+
 from .version import __version__
 
+
 def firetail_handler(enable_sleeper=False):
     def decorator(func):
         def wrapper_func(*args, **kwargs):

firetail_lambda/version.py

@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "0.1.1"

setup.cfg

@@ -1,2 +1,5 @@
 [metadata]
 license_files = LICENSE
+[coverage:run]
+omit =
+    setup.py

setup.py

@@ -1,16 +1,17 @@
+from os.path import dirname, join
+
 import setuptools
-from os.path import join, dirname
 
 with open('README.md', 'r', encoding='utf-8') as fh:
     long_description = fh.read()
 
-# with open(join(dirname(__file__), 'firetail_lambda/version.py'), 'r') as f:
-#     exec(f.read())
+with open(join(dirname(__file__), 'firetail_lambda/version.py'), 'r') as f:
+    exec(f.read())
 
 setuptools.setup(
     name='Firetail-Lambda',
     author='Riley Priddle',
-    version='0.1.0',
+    version=__version__,
     author_email='[email protected]',
     description='Firetail Lambda Package',
     keywords='pypi, package',

tests/test_firetail.py

@@ -1,10 +1,14 @@
-import unittest
-import json
+
+
 import contextlib
+import json
+import time
+import unittest
 from io import StringIO
 
 from firetail_lambda import firetail_handler
 
+
 class TestSimple(unittest.TestCase):
 
     def test_handler_api(self):
@@ -19,6 +23,35 @@ def handler(event, context):
         output = temp_stdout.getvalue().strip()
         self.assertEqual(output, 'firetail:loggingapi:eyJldmVudCI6IHt9LCAicmVzcG9uc2UiOiBbMjAxLCAie1wibWVzc2FnZVwiOiBcInN1Y2Nlc3NcIn0iXX0=')
 
+    def test_incorrect_handler_api(self):
+        event = {}
+        @firetail_handler()
+        def handler(argument):
+            return 201, json.dumps({"message": "success"})
+        
+        temp_stdout = StringIO()
+        with contextlib.redirect_stdout(temp_stdout):
+            handler(event)
+        output = temp_stdout.getvalue().strip()
+        self.assertEqual(output, '')
+
+    def test_handler_sleeper_api(self):
+        event = {}
+        @firetail_handler(enable_sleeper=True)
+        def handler(event, context):
+            return 201, json.dumps({"message": "success"})
+        
+        temp_stdout = StringIO()
+        with contextlib.redirect_stdout(temp_stdout):
+            start = time.time()
+            handler(event, "")
+            end = time.time()
+            
+            difference = end - start
+        output = temp_stdout.getvalue().strip()
+        self.assertGreaterEqual(difference, .5)
+        self.assertEqual(output, 'firetail:loggingapi:eyJldmVudCI6IHt9LCAicmVzcG9uc2UiOiBbMjAxLCAie1wibWVzc2FnZVwiOiBcInN1Y2Nlc3NcIn0iXX0=')
+
 
-if __name__ == '__main__':
-    unittest.main()
+if __name__ == '__main__': # pragma: no cover
+    unittest.main() # pragma: no cover

tox.ini

@@ -1,3 +1,7 @@
+[isort]
+profile = black
+multi_line_output = 3
+
 [tox]
 envlist = py{38,39}
 minversion = 3.3.0
@@ -7,7 +11,11 @@ isolated_build = true
 deps =
     check-manifest >= 0.42
     pytest
+    pytest-cov
+    coverage
+    isort
 commands =
     check-manifest --ignore 'tox.ini,tests/**,.editorconfig,vscode.env,.vscode/**'
     python setup.py check -m -s
-    pytest tests {posargs}
+    pytest --cov ./ --cov-report xml:{toxinidir}/coverage.xml
+    isort . --project firetail_lambda --check-only --diff