feat: bootstrap 5 and html5 validation

Author: rjsparks

.devcontainer/devcontainer.json

@@ -10,6 +10,13 @@
     "containerEnv": {
         "EDITOR_VSCODE": "true"
     },
+
+    "features": {
+        "docker-in-docker": {
+            "version": "latest"
+        },
+        "github-cli": "latest"
+    },
 
     // Set *default* container specific settings.json values on container create.
     "settings": { 

.devcontainer/docker-compose.extend.yml

@@ -7,5 +7,7 @@ services:
         volumes:
             - .:/workspace
             - /workspace/node_modules
+            - /workspace/.parcel-cache
+            - /workspace/__pycache__
         # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
         network_mode: service:db

.editorconfig

@@ -4,59 +4,39 @@
 
 root = true
 
-# Settings for IETF datatracker
+# Global settings for IETF datatracker
 # ---------------------------------------------------------
 # PEP8 Style
 
 [*]
-indent_style = space
 indent_size = 4
-end_of_line = lf
+indent_style = space
 charset = utf-8
-# to avoid tripping Henrik's commit hook:
 trim_trailing_whitespace = false
-insert_final_newline = false
+insert_final_newline = true
+
+# Specializations below *add to* the above defaults
 
 # Settings for .github folder
 # ---------------------------------------------------------
 # GitHub Markdown Style
 
 [.github/**]
-indent_style = space
 indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = false
-insert_final_newline = true
 
 # Settings for client-side JS / Vue files
 # ---------------------------------------------------------
 # StandardJS Style
 
 [client/**]
-indent_style = space
 indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
 
 [package.json]
-indent_style = space
 indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
 
 # Settings for cypress tests
 # ---------------------------------------------------------
 # StandardJS Style
 
 [cypress/**]
-indent_style = space
 indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

.eslintrc.js

@@ -1,19 +1,24 @@
 module.exports = {
+    extends: ["eslint:recommended"],
     rules: {
-        indent: [2, 4],
-        camelcase: 0,
-        "require-jsdoc": 0,
-        quotes: [2, "double"],
-        "no-multiple-empty-lines": [2, {max: 2}],
-        "quote-props": [2, "as-needed"],
-        "brace-style": [2, "1tbs", {allowSingleLine: true}]
+        indent: ["error", 4],
+        quotes: "off",
+        "no-multiple-empty-lines": ["error", { max: 2, maxEOF: 0 }],
+        "quote-props": ["error", "as-needed"],
+        "brace-style": ["error", "1tbs", { allowSingleLine: true }],
+        semi: ["error", "always"],
+        "newline-per-chained-call": ["error"]
     },
     env: {
         browser: true,
-        jquery: true
+        jquery: true,
+        node: true
     },
     globals: {
         d3: true
     },
-    extends: "google"
-};
+    parserOptions: {
+        sourceType: "module",
+        ecmaVersion: 2015
+    }
+};

.github/workflows/build-test-base.yml

@@ -8,6 +8,7 @@ on:
     paths:
       - 'package.json'
       - 'requirements.txt'
+      - 'dev/tests/Dockerfile'
 
   workflow_dispatch:
 
@@ -31,6 +32,6 @@ jobs:
         image: ${{ env.IMAGE_NAME }}
         tags: latest
         registry: ${{ env.REGISTRY }}
-        dockerfile: dev/docker-test-base/Dockerfile
+        dockerfile: dev/tests/Dockerfile
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build.yml

@@ -11,16 +11,33 @@ on:
         description: 'Create Production Release'
         required: true
         type: boolean
+      skiptests:
+        description: 'Skip Tests'
+        required: true
+        type: boolean
+      summary:
+        description: 'Summary'
+        required: false
+        type: string
+        default: ''
 
 jobs:
-  publish:
+  # -----------------------------------------------------------------
+  # PREPARE
+  # -----------------------------------------------------------------
+  prepare:
+    name: Prepare Release
     runs-on: ubuntu-latest
+    outputs:
+      should_deploy: ${{ steps.buildvars.outputs.should_deploy }}
+      pkg_version: ${{ steps.buildvars.outputs.pkg_version }}
+      pkg_version_strict: ${{ steps.buildvars.outputs.pkg_version_strict }}
 
     steps:
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0
-        
+
     - name: Get Next Version
       if: ${{ github.event.inputs.publish == 'true' }}
       id: semver
@@ -49,26 +66,103 @@ jobs:
         token: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Set Build Variables
+      id: buildvars
       run: |
         if [[ $NEXT_VERSION ]]; then
           echo "Using AUTO SEMVER mode: $NEXT_VERSION"
-          echo "SHOULD_DEPLOY=true" >> $GITHUB_ENV
-          echo "PKG_VERSION=$NEXT_VERSION" >> $GITHUB_ENV
-          echo "PKG_VERSION_STRICT=${NEXT_VERSION#?}" >> $GITHUB_ENV
+          echo "::set-output name=should_deploy::true"
+          echo "::set-output name=pkg_version::$NEXT_VERSION"
+          echo "::set-output name=pkg_version_strict::${NEXT_VERSION#?}"
           echo "::notice::Release created using branch $GITHUB_REF_NAME"
         elif [[ "$GITHUB_REF" =~ ^refs/tags/v* ]]; then
           echo "Using TAG mode: $GITHUB_REF_NAME"
-          echo "SHOULD_DEPLOY=true" >> $GITHUB_ENV
-          echo "PKG_VERSION=$GITHUB_REF_NAME" >> $GITHUB_ENV
-          echo "PKG_VERSION_STRICT=${GITHUB_REF_NAME#?}" >> $GITHUB_ENV
+          echo "::set-output name=should_deploy::true"
+          echo "::set-output name=pkg_version::$GITHUB_REF_NAME"
+          echo "::set-output name=pkg_version_strict::${GITHUB_REF_NAME#?}"
           echo "::notice::Release created using tag $GITHUB_REF_NAME"
         else
           echo "Using TEST mode: v7.0.0-dev.$GITHUB_RUN_NUMBER"
-          echo "SHOULD_DEPLOY=false" >> $GITHUB_ENV
-          echo "PKG_VERSION=v3.0.0-dev.$GITHUB_RUN_NUMBER" >> $GITHUB_ENV
-          echo "PKG_VERSION_STRICT=3.0.0-dev.$GITHUB_RUN_NUMBER" >> $GITHUB_ENV
+          echo "::set-output name=should_deploy::false"
+          echo "::set-output name=pkg_version::v7.0.0-dev.$GITHUB_RUN_NUMBER"
+          echo "::set-output name=pkg_version_strict::7.0.0-dev.$GITHUB_RUN_NUMBER"
           echo "::notice::Non-production build created using branch $GITHUB_REF_NAME"
         fi
+
+  # -----------------------------------------------------------------
+  # TESTS
+  # -----------------------------------------------------------------
+  tests:
+    name: Run Tests
+    if: ${{ github.event.inputs.skiptests == 'false' }}
+    needs: [prepare]
+    runs-on: ubuntu-latest
+    container: ghcr.io/ietf-tools/datatracker-test-base:latest
+    
+    services:
+      db:
+        image: ghcr.io/ietf-tools/datatracker-db:latest
+        volumes:
+            - mariadb-data:/var/lib/mysql
+        env:
+            MYSQL_ROOT_PASSWORD: ietf
+            MYSQL_DATABASE: ietf_utf8
+            MYSQL_USER: django
+            MYSQL_PASSWORD: RkTkDPFnKpko
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Prepare for tests
+      run: |
+        chmod +x ./dev/tests/prepare.sh
+        sh ./dev/tests/prepare.sh
+        
+    - name: Ensure DB is ready
+      run: |
+        /usr/local/bin/wait-for db:3306 -- echo "DB ready"
+        
+    - name: Run all tests
+      run: |
+        echo "Running checks..."
+        ./ietf/manage.py check
+        echo "Running tests..."
+        ./ietf/manage.py test --settings=settings_sqlitetest
+        coverage xml
+
+    - name: Upload Coverage Results to Codecov
+      uses: codecov/codecov-action@v2.1.0
+      with:
+        files: coverage.xml
+        
+    - name: Convert Coverage Results
+      if: ${{ always() }}
+      run: |
+        mv latest-coverage.json coverage.json
+        
+    - name: Upload Coverage Results as Build Artifact
+      uses: actions/upload-artifact@v3.0.0
+      if: ${{ always() }}
+      with:
+        name: coverage
+        path: coverage.json
+        
+  # -----------------------------------------------------------------
+  # RELEASE
+  # -----------------------------------------------------------------
+  release:
+    name: Make Release
+    if: ${{ always() }}
+    needs: [tests, prepare]
+    runs-on: ubuntu-latest
+    env:
+      SHOULD_DEPLOY: ${{needs.prepare.outputs.should_deploy}}
+      PKG_VERSION: ${{needs.prepare.outputs.pkg_version}}
+      PKG_VERSION_STRICT: ${{needs.prepare.outputs.pkg_version_strict}}
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
 
     - name: Setup Node.js
       uses: actions/setup-node@v3.0.0
@@ -80,17 +174,27 @@ jobs:
       with:
         python-version: '3.x'
 
+    - name: Download a Coverage Results
+      if: ${{ github.event.inputs.skiptests == 'false' }}
+      uses: actions/download-artifact@v3.0.0
+      with:
+        name: coverage
+        
     - name: Make Release Build
       env:
         DEBIAN_FRONTEND: noninteractive
       run: |
+        echo "PKG_VERSION: $PKG_VERSION"
+        echo "PKG_VERSION_STRICT: $PKG_VERSION_STRICT"
+        echo "GITHUB_SHA: $GITHUB_SHA"
+        echo "GITHUB_REF_NAME: $GITHUB_REF_NAME"
         echo "Running build script..."
         chmod +x ./dev/deploy/build.sh
         sh ./dev/deploy/build.sh
         echo "Setting version $PKG_VERSION_STRICT..."
-        sed -i -r -e "s/^__version__ += '.*'$/__version__ = '$PKG_VERSION_STRICT'/" ietf/__init__.py
-        sed -i -r -e "s/^__release_hash__ += '.*'$/__release_hash__ = '$GITHUB_SHA'/" ietf/__init__.py
-        sed -i -r -e "s/^__release_branch__ += '.*'$/__release_branch__ = '$GITHUB_REF_NAME'/" ietf/__init__.py
+        sed -i -r -e "s|^__version__ += '.*'$|__version__ = '$PKG_VERSION_STRICT'|" ietf/__init__.py
+        sed -i -r -e "s|^__release_hash__ += '.*'$|__release_hash__ = '$GITHUB_SHA'|" ietf/__init__.py
+        sed -i -r -e "s|^__release_branch__ += '.*'$|__release_branch__ = '$GITHUB_REF_NAME'|" ietf/__init__.py
         echo "Build release tarball..."
         mkdir -p /home/runner/work/release
         tar -czf /home/runner/work/release/release.tar.gz -X dev/deploy/exclude-patterns.txt .
@@ -103,6 +207,25 @@ jobs:
         token: ${{ github.token }}
         tag: ${{ env.PKG_VERSION }}
         writeToFile: false
+
+    - name: Prepare Coverage Action
+      if: ${{ github.event.inputs.skiptests == 'false' }}
+      working-directory: ./dev/coverage-action
+      run: npm install
+        
+    - name: Process Coverage Stats + Chart
+      id: covprocess
+      uses: ./dev/coverage-action/
+      if: ${{ github.event.inputs.skiptests == 'false' }}
+      with:
+        token: ${{ github.token }}
+        tokenCommon: ${{ secrets.GH_COMMON_TOKEN }}
+        repoCommon: common
+        version: ${{needs.prepare.outputs.pkg_version}}
+        changelog: ${{ steps.changelog.outputs.changes }}
+        summary: ${{ github.event.inputs.summary }}
+        coverageResultsPath: coverage.json
+        histCoveragePath: historical-coverage.json
 
     - name: Create Release
       uses: ncipollo/release-action@v1
@@ -112,8 +235,8 @@ jobs:
         draft: false
         tag: ${{ env.PKG_VERSION }}
         name: ${{ env.PKG_VERSION }}
-        body: ${{ steps.changelog.outputs.changes }}
-        artifacts: "/home/runner/work/release/release.tar.gz"
+        body: ${{ steps.covprocess.outputs.changelog }}
+        artifacts: "/home/runner/work/release/release.tar.gz,coverage.json,historical-coverage.json"
         token: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Upload Build Artifacts