Merge pull request #1243 from consideRatio/pr/updates-to-ci

[MRG] ci: extracted full_namespace_report script to a github action and misc

Author: consideRatio

.github/workflows/codeql-analysis.yml

@@ -1,19 +1,9 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
 name: "CodeQL"
 
 on:
-  push:
-    branches: [master]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [master]
   schedule:
-    # At 13:29 on Friday - https://crontab.guru/
-    - cron: '29 13 * * 5'
+    # At 05:00 - https://crontab.guru/
+    - cron: '0 5 * * *'
 
 jobs:
   analyze:
@@ -23,32 +13,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Override automatic language detection by changing the below list
-        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
-        language: ['python', 'javascript']
-        # Learn more...
-        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+        language: [ 'python', 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
     - name: Checkout repository
       uses: actions/checkout@v2
-      with:
-        # We must fetch at least the immediate parents so that if this is
-        # a pull request then we can checkout the head.
-        fetch-depth: 2
-
-    # If this run was triggered by a pull request event, then checkout
-    # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file. 
+        # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
 

.github/workflows/publish.yml

@@ -6,16 +6,6 @@ on:
     branches: [main, master]
     tags: ["**"]
 
-defaults:
-  run:
-    # Declare bash be used by default in this workflow's "run" steps.
-    #
-    # NOTE: bash will by default run with:
-    #   --noprofile: Ignore ~/.profile etc.
-    #   --norc:      Ignore ~/.bashrc etc.
-    #   -e:          Exit directly on errors
-    #   -o pipefail: Don't mask errors from a command piped into another command
-    shell: bash
 
 jobs:
   # Builds and pushes docker images to DockerHub, packages the Helm chart and

.github/workflows/test.yml

@@ -7,9 +7,6 @@ on:
     tags: ["**"]
   workflow_dispatch:
 
-defaults:
-  run:
-    shell: bash
 
 jobs:
   # Most of the "main", "auth" and "helm" jobs are the same and only differ
@@ -22,47 +19,29 @@ jobs:
       fail-fast: false
       matrix:
         include:
-            # This version of k3s uses kubernetes v1.18
-            - k3s-version: v1.18.10+k3s2
-              helm_version: v3.4.1
+            - k3s-channel: v1.19
+              helm-version: v3.5.0
               test: main
-            - k3s-version: v1.18.10+k3s2
-              helm_version: v3.4.1
+            - k3s-channel: v1.19
+              helm-version: v3.5.0
               test: auth
-            - k3s-version: v1.18.10+k3s2
-              helm_version: v3.4.1
+            - k3s-channel: v1.19
+              helm-version: v3.5.0
               test: helm
     steps:
       - uses: actions/checkout@v2
         with:
           # chartpress requires the full history
           fetch-depth: 0
-      - uses: jupyterhub/[email protected]
+
+      - uses: jupyterhub/action-k3s-helm@v1
         with:
           k3s-version: ${{ matrix.k3s-version }}
           helm-version: ${{ matrix.helm-version }}
           metrics-enabled: false
           traefik-enabled: false
           docker-enabled: true
-      - uses: actions/setup-python@v2
-        with:
-          python-version: '3.8'
-      - name: Display kubernetes related details
-        run: |
-            echo "kubeconfig: $KUBECONFIG"
-            echo
-            echo "List of running pods:"
-            kubectl get pods --all-namespaces
-            echo
-            echo "List of cluster nodes:"
-            kubectl get nodes
-            echo
-            echo "Helm list output:"
-            helm list
-      - name: Setup helm chart repositories
-        run: |
-            helm repo add jupyterhub https://jupyterhub.github.io/helm-chart/
-            helm repo update
+
       - name: Setup OS level dependencies
         run: |
             sudo apt-get update
@@ -71,40 +50,54 @@ jobs:
               curl \
               libcurl4-openssl-dev \
               libssl-dev
+
       - uses: actions/setup-node@v2-beta
         with:
           node-version: '14'
+
       - name: Run webpack to build static assets
         run: |
             npm install
             npm run webpack
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
       - name: Setup Python package dependencies
         run: |
             # Install development requirements, package requirements, and frozen image
             # requirements, with an increasing priority.
             pip install -r dev-requirements.txt
             pip install .
             pip install -r helm-chart/images/binderhub/requirements.txt
+
       - name: Install JupyterHub chart for main tests
         if: matrix.test == 'main'
-        run: ./testing/local-binder-k8s-hub/install-jupyterhub-chart
+        run: |
+            ./testing/local-binder-k8s-hub/install-jupyterhub-chart
+
       - name: Install JupyterHub chart for auth tests
         if: matrix.test == 'auth'
-        run: ./testing/local-binder-k8s-hub/install-jupyterhub-chart --auth
+        run: |
+            ./testing/local-binder-k8s-hub/install-jupyterhub-chart --auth
+
       - name: Use chartpress to create the helm chart
         if: matrix.test == 'helm'
         run: |
             # Use chartpress to create the helm chart and build its images
             helm dependency update ./helm-chart/binderhub
             (cd helm-chart && chartpress)
-            git --no-pager diff
+            git --no-pager diff --color=always
+
       - name: Validate the chart against the k8s API
         if: matrix.test == 'helm'
         run: |
             helm template --validate binderhub-test helm-chart/binderhub \
                 --values testing/k8s-binder-k8s-hub/binderhub-chart-config.yaml \
                 --set config.BinderHub.hub_url=http://localhost:30902 \
                 --set config.BinderHub.access_token=$GITHUB_ACCESS_TOKEN
+
       - name: Install the chart
         if: matrix.test == 'helm'
         run: |
@@ -113,57 +106,48 @@ jobs:
               --set config.BinderHub.hub_url=http://localhost:30902 \
               --set config.BinderHub.hub_url_local=http://proxy-public \
               --set config.BinderHub.access_token=$GITHUB_ACCESS_TOKEN
+
       - name: Wait for JupyterHub to be ready
         timeout-minutes: 10
         run: |
-            # Wait for JupyterHub to be ready
-            set -e
             . ci/common
             await_jupyterhub
-            # Next few commands are here for sanity checking/debugging of CI
-            # related issues
-            echo "Proxy service details"
-            kubectl get svc proxy-public -o json
-            echo
-            echo "kubectl describe svc proxy-public"
-            kubectl describe svc proxy-public
-            echo
-            echo "kubectl get svc"
-            kubectl get svc
-            echo
             echo "curl http://localhost:30902/hub/api/" should print the JupyterHub version
             curl http://localhost:30902/hub/api/
+
       - name: Wait for BinderHub to be ready
         if: matrix.test == 'helm'
         timeout-minutes: 10
         run: |
-            # Wait for BinderHub to be ready
-            set -e
             . ci/common
             await_binderhub
             echo "curl http://localhost:30901/health" to check BinderHub\'s health
             curl http://localhost:30901/health
-            echo
+
       - name: Run main tests
         if: matrix.test == 'main'
         # running the "main" tests means "all tests that aren't auth"
         run: pytest -m "not auth" -v --maxfail=10 --cov binderhub --durations=10 --color=yes
+
       - name: Run auth tests
         if: matrix.test == 'auth'
         # running the "auth" tests means "all tests that are marked as auth"
         run: pytest -m "auth" -v --maxfail=10 --cov binderhub --durations=10 --color=yes
+
       - name: Run helm tests
         if: matrix.test == 'helm'
         run: |
             export BINDER_URL=http://localhost:30901
             pytest -m "remote" -v --maxfail=10 --cov binderhub --durations=10 --color=yes
+
+      # GitHub Action reference: https://github.com/jupyterhub/action-k8s-namespace-report
       - name: Kubernetes namespace report
-        if: ${{ always() }}
-        run: |
-          # Display debugging information and always provide the logs from
-          # certain important k8s deployments.
-          . ci/common
-          full_namespace_report deploy/binder deploy/hub deploy/proxy
+        uses: jupyterhub/action-k8s-namespace-report@v1
+        if: always()
+        with:
+          important-workloads: deploy/binder deploy/hub deploy/proxy
+
+      # GitHub action reference: https://github.com/codecov/codecov-action
       - name: Upload coverage stats
         uses: codecov/codecov-action@v1
         if: ${{ always() }}

README.md

@@ -1,7 +1,8 @@
 # [BinderHub](https://github.com/jupyterhub/binderhub)
 
 [![Documentation Status](https://img.shields.io/readthedocs/binderhub?logo=read-the-docs)](https://binderhub.readthedocs.io/en/latest/)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jupyterhub/binderhub/Tests?logo=github)](https://github.com/jupyterhub/binderhub/actions)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jupyterhub/binderhub/Tests?logo=github&label=tests)](https://github.com/jupyterhub/binderhub/actions)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jupyterhub/binderhub/CodeQL?logo=github&label=code%20scans)](https://github.com/jupyterhub/binderhub/actions)
 [![Latest chart development release](https://img.shields.io/badge/dynamic/json.svg?label=latest&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.binderhub.latest&colorB=orange)](https://jupyterhub.github.io/helm-chart/)
 [![GitHub](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/jupyterhub/binderhub/issues)
 [![Discourse](https://img.shields.io/badge/help_forum-discourse-blue.svg)](https://discourse.jupyter.org/c/binder/binderhub)