Feedback

.github/workflows/black.yml

@@ -0,0 +1,20 @@
+name: Black Styling
+
+on: [push, pull_request]
+
+jobs:
+  linter_name:
+    name: runner / black
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Check files using the black formatter
+        uses: rickstaa/action-black@v1
+        id: action_black
+        with:
+          black_args: "--check ."
+      - name: Annotate diff changes using reviewdog
+        if: steps.action_black.outputs.is_formatted == 'true'
+        uses: reviewdog/action-suggester@v1
+        with:
+          tool_name: blackfmt

.github/workflows/eslint.yml

@@ -0,0 +1,21 @@
+name: ESLint
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        # Make sure the actual branch is checked out when running on pull requests
+        ref: ${{ github.head_ref }}
+
+    - name: Install dependencies
+      run: npm install --no-package-lock eslint eslint-plugin-react --legacy-peer-deps
+      working-directory: src/frontend/
+
+    - name: Run ESLint
+      run: npx eslint --max-warnings 0 $(git ls-files '*.js' '*.jsx' '*.ts' '*.tsx')
+      working-directory: src/frontend/

.github/workflows/jest-coverage.yml

@@ -0,0 +1,20 @@
+name: Jest Coverage Calculation
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: npm ci --legacy-peer-deps
+        working-directory: src/frontend
+
+      - name: Run tests
+        run: |
+          npx ts-jest config:init --coverage --coverageReporters json-summary
+        working-directory: src/frontend
+
+      - name: Jest coverage comment
+        uses: MishaKav/jest-coverage-comment@main

.github/workflows/prettier.yml

@@ -0,0 +1,19 @@
+name: Prettier Styling
+
+on: [push, pull_request]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          # Make sure the actual branch is checked out when running on pull requests
+          ref: ${{ github.head_ref }}
+
+      - name: Prettify code
+        run: |
+          npx prettier --check src/.
+        working-directory: src/frontend

.github/workflows/pylint.yml

@@ -0,0 +1,31 @@
+name: Pylint
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flask
+        pip install pylint
+        pip install pytest==7.1.3
+        pip install flask-cors
+        pip install BeautifulSoup4
+        pip install Flask-Session2
+        pip install Authlib
+        pip install requests
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')
+      working-directory: src/backend

.github/workflows/pytest-coverage.yml

@@ -0,0 +1,45 @@
+name: Pytest Coverage Calculation
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: wget https://sqlite.org/2022/sqlite-autoconf-3380500.tar.gz
+      - run: tar -xvf sqlite-autoconf-3380500.tar.gz
+      - run: ./configure
+        working-directory: sqlite-autoconf-3380500
+      - run: make
+        working-directory: sqlite-autoconf-3380500
+      - run: sudo make install
+        working-directory: sqlite-autoconf-3380500
+      - run: export PATH="/usr/local/lib:$PATH"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest pytest-cov
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        working-directory: src/backend
+
+      - name: Build coverage file
+        run: |
+          pytest --junitxml=pytest.xml --cov-report=term-missing --cov=. | tee pytest-coverage.txt
+        env:
+          LD_LIBRARY_PATH: /usr/local/lib
+        working-directory: src/backend
+
+      - name: Pytest coverage comment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: src/backend/pytest-coverage.txt
+          junitxml-path: src/backend/pytest.xml

.github/workflows/python-app.yml

@@ -0,0 +1,55 @@
+# 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 Application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - run: wget https://sqlite.org/2022/sqlite-autoconf-3380500.tar.gz
+    - run: tar -xvf sqlite-autoconf-3380500.tar.gz
+    - run: ./configure
+      working-directory: sqlite-autoconf-3380500
+    - run: make
+      working-directory: sqlite-autoconf-3380500
+    - run: sudo make install
+      working-directory: sqlite-autoconf-3380500
+    - run: export PATH="/usr/local/lib:$PATH"
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      working-directory: src/backend
+    - 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. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      working-directory: src/backend
+    - name: Test with pytest
+      run: |
+        pytest
+      env:
+        LD_LIBRARY_PATH: /usr/local/lib
+      working-directory: src/backend

.gitignore

@@ -0,0 +1,38 @@
+
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+venv
+__pycache__
+.vscode
+# dependencies
+src/frontend/node_modules
+/.pnp
+.pnp.js
+src/backend/.pytest_cache
+.pytest_cache
+src/backend/__pycache__
+src/backend/flask_session
+
+src/frontend/my-app/node_modules
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# tests
+/src/backend/.coverage
+/src/backend/pytest-coverage.txt
+/src/backend/pytest.xml
+/src/backend/database/database.db-journal
+

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Move Securely
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.