Adds tests

Author: joncloud

.github/workflows/python.yml

@@ -0,0 +1,37 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ publish ]
+  pull_request:
+    branches: [ publish ]
+
+jobs:
+  build:
+    runs-on: 'ubuntu-20.04'
+
+    steps:
+    - uses: 'actions/checkout@v2'
+
+    - name: 'Use Python 3.9'
+      uses: 'actions/setup-python@v2'
+      with:
+        python-version: '3.9'
+
+    - name: 'Installs requirements.txt'
+      run: pip install -r ./requirements.txt
+
+    - name: 'Prep Tests'
+      run: bash ./prep.sh
+
+    - name: 'Run Tests'
+      run: nose2 -v --config ./unittest.cfg main_test
+
+    - name: 'Publish Tests'
+      uses: 'dorny/test-reporter@v1'
+      # run this step even if previous step failed
+      if: ${{ !env.ACT }} && (success() || failure())
+      with:
+        name: Tests
+        path: 'nose2-junit.xml'
+        reporter: java-junit

flask_app.py

@@ -0,0 +1,11 @@
+from flask import Flask
+
+app = Flask(__name__)
+
+@app.route("/")
+def ok():
+    return "1"
+
+@app.route("/fail")
+def not_found():
+  return "0", 404

locust_test.py

@@ -0,0 +1,10 @@
+from locust import HttpUser, task
+
+class LocustUser(HttpUser):
+  @task
+  def ok(self):
+    self.client.get("/")
+
+  @task
+  def not_found(self):
+    self.client.get("/fail")

main.py

@@ -12,7 +12,7 @@ def main(argv):
     prefix = ''
 
     try:
-        opts, _ = getopt.getopt(sys.argv[1:], 'hp:', ['prefix='])
+        opts, _ = getopt.getopt(argv, 'hp:', ['prefix='])
     except getopt.GetoptError:
         print('main.py -p <prefix>')
         sys.exit(2)
@@ -57,25 +57,21 @@ def append_testcases(prefix, testsuite):
     with open(csv_file_path, mode='r') as csv_file:
         csv_reader = csv.DictReader(csv_file)
 
-        line_count = 0
         for row in csv_reader:
 
-            if line_count > 0:
-                row_method = row['Type']
-                row_name = row['Name']
+            row_method = row['Type']
+            row_name = row['Name']
 
-                if row_method != 'None' and row_name != 'Total':
-                    testcase = ET.SubElement(testsuite, 'testcase')
+            if row_method != '' and row_method != 'None' and row_name != 'Total':
+                testcase = ET.SubElement(testsuite, 'testcase')
 
-                    name = f'{row_method}\t{row_name} Average response time'
-                    testcase.set('name', name)
+                name = f'{row_method}\t{row_name} Average response time'
+                testcase.set('name', name)
 
-                    test_count += int(row['Request Count'])
-                    failure_count += int(row['Failure Count'])
-                    avg_response_s = float(row['Average Response Time']) / 1000
-                    testcase.set('time', str(avg_response_s))
-
-            line_count += 1
+                test_count += int(row['Request Count'])
+                failure_count += int(row['Failure Count'])
+                avg_response_s = float(row['Average Response Time']) / 1000
+                testcase.set('time', str(avg_response_s))
 
         testsuite.set('tests', str(test_count))
         testsuite.set('failures', str(failure_count))

main_test.py

@@ -0,0 +1,58 @@
+from main import main
+import junitparser
+import os
+import unittest
+
+def convert_results(prefix: str) -> str:
+  xml_file_path = os.path.join(
+    os.getcwd(),
+    'test_results.xml'
+  )
+  if os.path.isfile(xml_file_path):
+    os.remove(xml_file_path)
+
+  argv = [
+    '--prefix', prefix
+  ]
+  main(argv)
+  return xml_file_path
+
+class TestMain(unittest.TestCase):
+
+  def assert_file(self, prefix: str, test_case_names: list[str]) -> None:
+    xml_file_path = convert_results(prefix)
+    self.assertTrue(os.path.isfile(xml_file_path))
+
+    junit_xml = junitparser.JUnitXml.fromfile(xml_file_path)
+
+    test_suites = list(junit_xml)
+    self.assertEqual(len(test_suites), 1)
+
+    test_suite = test_suites[0]
+    self.assertEqual(test_suite.name, 'Locust Tests')
+    self.assertGreater(test_suite.tests, 0)
+    self.assertGreater(test_suite.failures, 0)
+
+    test_cases = list(test_suite)
+    self.assertEqual(len(test_cases), len(test_case_names))
+
+    for index, test_case_name in enumerate(test_case_names):
+      self.assertEqual(test_cases[index].name, test_case_name)
+      self.assertEqual(type(test_cases[index].time), float)
+
+    return
+
+  def test_conversion(self):
+    self.assert_file('prefix1', [
+      'GET\t/ Average response time',
+      'GET\t/fail Average response time',
+    ])
+
+    self.assert_file('prefix2', [
+      'GET\t/ Average response time',
+      'GET\t/fail Average response time',
+    ])
+    return
+
+if __name__ == '__main__':
+  unittest.main()

prep.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set_return() { return $1; }
+FLASK_APP=flask_app.py flask run > /dev/null &
+FLASK_PID=$!
+
+locust -f locust_test.py --csv=prefix1 --headless -t20s --host http://localhost:5000 > /dev/null
+locust -f locust_test.py --csv=prefix2 --headless -t20s --host http://localhost:5000 > /dev/null
+
+kill $FLASK_PID
+set_return 0

requirements.txt

@@ -0,0 +1,4 @@
+Flask==2.0.2
+junitparser==2.1.1
+locust==2.4.3
+nose2==0.10.0

unittest.cfg

@@ -0,0 +1,8 @@
+[unittest]
+plugins = nose2.plugins.junitxml
+
+[junit-xml]
+always-on = True
+keep_restricted = False
+path = nose2-junit.xml
+test_fullname = True