Merge branch 'develop' into flags-refactor

Author: abhinavsingh

.deepsource.toml

@@ -7,7 +7,6 @@ test_patterns = [
 
 exclude_patterns = [
     "helper/**",
-    "menubar/**"
 ]
 
 [[analyzers]]

.github/workflows/test-library.yml

@@ -540,6 +540,66 @@ jobs:
         flags: pytest, GHA, Python ${{ matrix.python }}, ${{ runner.os }}
         verbose: true
 
+  test-container:
+    runs-on: Ubuntu-latest
+    permissions:
+      packages: write
+    if: success()
+    needs:
+    - pre-setup  # transitive, for accessing settings
+    - build
+    name: 🐳 Build & Test
+    strategy:
+      fail-fast: false
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.inputs.release-commitish }}
+    - name: Download all the dists
+      uses: actions/download-artifact@v2
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: docker/setup-buildx-action@v1
+      # See https://github.com/docker/buildx/issues/850#issuecomment-996408167
+      with:
+        version: v0.7.0
+        buildkitd-flags: --debug
+        config: .github/buildkitd.toml
+        install: true
+    - name: Enable Multiarch    # This slows down arm build by 4-5x
+      run: |
+        docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+    - name: Create builder
+      run: |
+        docker buildx create --name proxypybuilder
+        docker buildx use proxypybuilder
+        docker buildx inspect
+        docker buildx ls
+    - name: Build, run & test container
+      run: >-
+        CONTAINER_TAG="abhinavsingh/proxy.py:${{
+          needs.pre-setup.outputs.container-version
+        }}";
+        docker buildx build
+        --load
+        --build-arg PROXYPY_PKG_PATH='dist/${{
+          needs.pre-setup.outputs.wheel-artifact-name
+        }}'
+        -t $CONTAINER_TAG .
+        &&
+        docker run
+        -d
+        -p 8899:8899
+        $CONTAINER_TAG
+        --hostname 0.0.0.0
+        --enable-web-server
+        &&
+        ./tests/integration/test_integration.sh 8899
+
   analyze:
     runs-on: ubuntu-latest
     name: 🛡️ Analyze
@@ -672,34 +732,15 @@ jobs:
         make ca-certificates
         python3 -m proxy --version
 
-  check:  # This job does nothing and is only used for the branch protection
-    if: always()
-
-    needs:
-    - analyze
-    - test
-    - lint
-    - dashboard
-    - brew
-    - developer
-
-    runs-on: Ubuntu-latest
-
-    steps:
-    - name: Decide whether the needed jobs succeeded or failed
-      uses: re-actors/alls-green@release/v1
-      with:
-        jobs: ${{ toJSON(needs) }}
-
-  docker:
+  ghcr-latest:
     runs-on: Ubuntu-latest
     permissions:
       packages: write
     if: success()
     needs:
-    - check
+    - test-container
     - pre-setup  # transitive, for accessing settings
-    name: 🐳 containerize
+    name: 🐳 ghcr:latest
     strategy:
       fail-fast: false
     steps:
@@ -736,26 +777,6 @@ jobs:
         docker buildx use proxypybuilder
         docker buildx inspect
         docker buildx ls
-    - name: Build, run & test container
-      run: >-
-        CONTAINER_TAG="abhinavsingh/proxy.py:${{
-          needs.pre-setup.outputs.container-version
-        }}";
-        docker buildx build
-        --load
-        --build-arg PROXYPY_PKG_PATH='dist/${{
-          needs.pre-setup.outputs.wheel-artifact-name
-        }}'
-        -t $CONTAINER_TAG .
-        &&
-        docker run
-        -d
-        -p 8899:8899
-        $CONTAINER_TAG
-        --hostname 0.0.0.0
-        --enable-web-server
-        &&
-        ./tests/integration/test_integration.sh 8899
     - name: Push to GHCR
       run: >-
         REGISTRY_URL="ghcr.io/abhinavsingh/proxy.py";
@@ -794,6 +815,52 @@ jobs:
           needs.pre-setup.outputs.wheel-artifact-name
         }}'
         -t $LATEST_TAG .
+
+  ghcr-openssl:
+    runs-on: Ubuntu-latest
+    permissions:
+      packages: write
+    if: success()
+    needs:
+    - test-container
+    - pre-setup  # transitive, for accessing settings
+    name: 🐳 ghcr:openssl
+    strategy:
+      fail-fast: false
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.inputs.release-commitish }}
+    - name: Download all the dists
+      uses: actions/download-artifact@v2
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Login to GHCR
+      uses: docker/login-action@v1
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: docker/setup-buildx-action@v1
+      # See https://github.com/docker/buildx/issues/850#issuecomment-996408167
+      with:
+        version: v0.7.0
+        buildkitd-flags: --debug
+        config: .github/buildkitd.toml
+        install: true
+    - name: Enable Multiarch    # This slows down arm build by 4-5x
+      run: |
+        docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+    - name: Create builder
+      run: |
+        docker buildx create --name proxypybuilder
+        docker buildx use proxypybuilder
+        docker buildx inspect
+        docker buildx ls
     - name: Push openssl to GHCR
       run: >-
         REGISTRY_URL="ghcr.io/abhinavsingh/proxy.py";
@@ -830,6 +897,46 @@ jobs:
           needs.pre-setup.outputs.wheel-artifact-name
         }}'
         -t $LATEST_TAG .
+
+  docker-latest:
+    runs-on: Ubuntu-latest
+    permissions:
+      packages: write
+    if: success()
+    needs:
+    - test-container
+    - pre-setup  # transitive, for accessing settings
+    name: 🐳 docker:latest
+    strategy:
+      fail-fast: false
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.inputs.release-commitish }}
+    - name: Download all the dists
+      uses: actions/download-artifact@v2
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: docker/setup-buildx-action@v1
+      # See https://github.com/docker/buildx/issues/850#issuecomment-996408167
+      with:
+        version: v0.7.0
+        buildkitd-flags: --debug
+        config: .github/buildkitd.toml
+        install: true
+    - name: Enable Multiarch    # This slows down arm build by 4-5x
+      run: |
+        docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+    - name: Create builder
+      run: |
+        docker buildx create --name proxypybuilder
+        docker buildx use proxypybuilder
+        docker buildx inspect
+        docker buildx ls
     - name: Login to DockerHub
       uses: docker/login-action@v1
       with:
@@ -853,6 +960,28 @@ jobs:
         }}'
         -t $CONTAINER_TAG .
 
+  check:  # This job does nothing and is only used for the branch protection
+    if: always()
+
+    needs:
+    - analyze
+    - test
+    - lint
+    - dashboard
+    - brew
+    - developer
+    - ghcr-latest
+    - ghcr-openssl
+    - docker-latest
+
+    runs-on: Ubuntu-latest
+
+    steps:
+    - name: Decide whether the needed jobs succeeded or failed
+      uses: re-actors/alls-green@release/v1
+      with:
+        jobs: ${{ toJSON(needs) }}
+
   publish-pypi:
     name: Publish 🐍📦 ${{ needs.pre-setup.outputs.git-tag }} to PyPI
     needs:

.isort.cfg

@@ -0,0 +1,24 @@
+# https://github.com/timothycrosley/isort/wiki/isort-Settings
+[settings]
+default_section = THIRDPARTY
+# force_to_top=file1.py,file2.py
+# forced_separate = django.contrib,django.utils
+include_trailing_comma = true
+indent = 4
+known_first_party = proxy
+# known_future_library = future,pies
+# known_standard_library = std,std2
+known_testing = pytest,unittest
+length_sort = 1
+# Should be: 80 - 1
+line_length = 79
+lines_after_imports = 2
+# https://pycqa.github.io/isort/docs/configuration/multi_line_output_modes.html
+# NOTE: Another mode could be "5" for grouping multiple "import from" under
+# NOTE: a single instruction.
+multi_line_output = 5
+no_lines_before = LOCALFOLDER
+sections=FUTURE,STDLIB,TESTING,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+# skip=file3.py,file4.py
+use_parentheses = true
+verbose = true

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
     - --py36-plus
 
 # - repo: https://github.com/timothycrosley/isort.git
-#   rev: 5.4.2
+#   rev: 5.10.0
 #   hooks:
 #   - id: isort
 #     args:
@@ -63,13 +63,6 @@ repos:
         src/core/plugins/inspect_traffic\.json|
         static/bootstrap-4\.3\.1\.min\.(cs|j)s
       )|
-      menubar/proxy\.py/(
-        Assets\.xcassets/(
-          AppIcon\.appiconset/|
-          StatusBarButtonImage\.imageset/|
-        )|
-        Preview\sContent/Preview\sAssets\.xcassets/
-      )Contents\.json|
       requirements-release\.txt
       $
   - id: requirements-txt-fixer

.vscode/settings.json

@@ -33,8 +33,7 @@
     ".venv*/**/*.py",
     "venv*/**/*.py",
     "docs/**/*.py",
-    "helper/**/*.py",
-    "menubar/**/*.py"
+    "helper/**/*.py"
   ],
   "python.linting.pylintEnabled": true,
   "python.linting.pylintArgs": ["--generate-members"],

MANIFEST.in

@@ -2,4 +2,3 @@ exclude ProxyPy.png
 exclude Dashboard.png
 exclude shortlink.gif
 prune dashboard
-prune menubar

Makefile

@@ -28,7 +28,7 @@ endif
 
 .PHONY: all https-certificates sign-https-certificates ca-certificates
 .PHONY: lib-check lib-clean lib-test lib-package lib-coverage lib-lint lib-pytest
-.PHONY: lib-release-test lib-release lib-profile lib-doc
+.PHONY: lib-release-test lib-release lib-profile lib-doc lib-pre-commit
 .PHONY: lib-dep lib-flake8 lib-mypy lib-speedscope container-buildx-all-platforms
 .PHONY: container container-run container-release container-build container-buildx
 .PHONY: devtools dashboard dashboard-clean container-without-openssl
@@ -91,16 +91,21 @@ lib-clean:
 	rm -rf proxy.py.egg-info
 	rm -rf .pytest_cache
 	rm -rf .hypothesis
+	# Doc RST files are cached and can cause issues
+	# See https://github.com/abhinavsingh/proxy.py/issues/642#issuecomment-1003444578
+	rm docs/pkg/*.rst
 
 lib-dep:
 	pip install --upgrade pip && \
 	pip install \
-		-r requirements.txt \
 		-r requirements-testing.txt \
 		-r requirements-release.txt \
 		-r requirements-tunnel.txt && \
 	pip install "setuptools>=42"
 
+lib-pre-commit:
+	python -m pre_commit run --hook-stage manual --all-files -v
+
 lib-lint:
 	python -m tox -e lint