Refactor into a composite action (#9)

* workflows/ci: lint at Python 3.7 Signed-off-by: William Woodruff <[email protected]> * action.py: Python 3.7 concessions Signed-off-by: William Woodruff <[email protected]> * Makefile: move `black` up Signed-off-by: William Woodruff <[email protected]> * action.yml: begin rewriting as composite WIP. Signed-off-by: William Woodruff <[email protected]> * action.yml: plumb inputs Signed-off-by: William Woodruff <[email protected]> * action.yml: plumb environment Signed-off-by: William Woodruff <[email protected]> * Dockerfile, action.yml: remove old Docker code Signed-off-by: William Woodruff <[email protected]> * action.yml: set working-directory for each step Signed-off-by: William Woodruff <[email protected]> * action.yml: remove working-directory settings These are wrong; we don't want to override the working directory like this. Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: add an environment selftest Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: fix args Signed-off-by: William Woodruff <[email protected]> * action: support virtual environments Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: add a selftest for venvs Signed-off-by: William Woodruff <[email protected]> * action: fix env handling Can't really be null, since we unconditionally populate variables. Signed-off-by: William Woodruff <[email protected]> * action: debugging support Signed-off-by: William Woodruff <[email protected]> * selftest: debug Signed-off-by: William Woodruff <[email protected]> * action.py: debugging Signed-off-by: William Woodruff <[email protected]> * action.py: debugging Signed-off-by: William Woodruff <[email protected]> * action.py: don't run pip-audit through `python -m` Conflicts with virtual environments. Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: actually assert outputs Signed-off-by: William Woodruff <[email protected]> * action: set an internal output containing the table Signed-off-by: William Woodruff <[email protected]> * selftest: another testing approach Signed-off-by: William Woodruff <[email protected]> * action: make the output base64 ...to avoid newlines, which break ::set-output Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: decode Signed-off-by: William Woodruff <[email protected]> * action.py: round-trip back to string Signed-off-by: William Woodruff <[email protected]> * action.py: docs Signed-off-by: William Woodruff <[email protected]> * selftest: test the selftest, fully Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: missing IDs Signed-off-by: William Woodruff <[email protected]> * selftest: debug Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: make it pass Signed-off-by: William Woodruff <[email protected]> * selftest: bump pip in venv Signed-off-by: William Woodruff <[email protected]> * selftest: install wheel too Sigh. Signed-off-by: William Woodruff <[email protected]> * action: push venv handling into the action's YAML Signed-off-by: William Woodruff <[email protected]> * action.yml: install pip-audit into a virtual environment, if requested Temporary workaround? Signed-off-by: William Woodruff <[email protected]> * action.yml: docs Signed-off-by: William Woodruff <[email protected]> * action.py: return to `python -m pip_audit ...` Signed-off-by: William Woodruff <[email protected]> * action: add a `local` setting, clean up Signed-off-by: William Woodruff <[email protected]> * README: ToC, documentation Signed-off-by: William Woodruff <[email protected]> * selftest: remove debugging Signed-off-by: William Woodruff <[email protected]> * selftest: test `local` Signed-off-by: William Woodruff <[email protected]> * test: add a pyproject test Signed-off-by: William Woodruff <[email protected]> * workflows/selftest: add a pyproject selftest Signed-off-by: William Woodruff <[email protected]> * selftest: fix key Signed-off-by: William Woodruff <[email protected]> * action.py: gate debug prints correctly Signed-off-by: William Woodruff <[email protected]> * selftest: drop no-deps for pyproject test Not supported yet, see pypa/pip-audit#305. Signed-off-by: William Woodruff <[email protected]> * README: tweak troubleshooting help Signed-off-by: William Woodruff <[email protected]> * meta: add LICENSE, sections to README Signed-off-by: William Woodruff <[email protected]>
pypa · Jun 16, 2022 · a84a2d8 · a84a2d8
1 parent 71fea02
commit a84a2d8
Show file tree

Hide file tree

Showing 9 changed files with 510 additions and 34 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,6 +13,6 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.7"
       - name: lint
         run: make lint
diff --git a/.github/workflows/selftest.yml b/.github/workflows/selftest.yml
@@ -8,15 +8,83 @@ on:
   workflow_dispatch:
 
 jobs:
-  selftest:
+  selftest-requirements:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: ./
+        id: pip-audit
         with:
           inputs: ./test/vulnerable.txt
           no-deps: true
           # NOTE: We intentionally allow failure here, since the self-test
           # explicitly uses a vulnerable requirements file.
           internal-be-careful-allow-failure: true
+      - name: assert expected output
+        env:
+          PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
+        run: |
+          grep -E 'pyyaml\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
 
+  selftest-environment:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: make the environment vulnerable
+        run: |
+          python -m pip install --no-deps --requirement ./test/vulnerable.txt
+      - uses: ./
+        id: pip-audit
+        with:
+          # NOTE: We intentionally allow failure here, since the self-test
+          # explicitly uses a vulnerable requirements file.
+          internal-be-careful-allow-failure: true
+      - name: assert expected output
+        env:
+          PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
+        run: |
+          grep -E 'pyyaml\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
+
+  selftest-virtualenv:
+    strategy:
+      matrix:
+        local: [true, false]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: make a virtual environment vulnerable
+        run: |
+          python -m venv env
+          ./env/bin/python -m pip install --upgrade pip wheel
+          ./env/bin/python -m pip install --no-deps --requirement ./test/vulnerable.txt
+      - uses: ./
+        id: pip-audit
+        with:
+          virtual-environment: env/
+          local: ${{ matrix.local }}
+          # NOTE: We intentionally allow failure here, since the self-test
+          # explicitly uses a vulnerable requirements file.
+          internal-be-careful-allow-failure: true
+      - name: assert expected output
+        env:
+          PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
+        run: |
+          grep -E 'pyyaml\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
+
+  selftest-pyproject:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./
+        id: pip-audit
+        with:
+          # should attempt to discover test/pyproject/pyproject.toml
+          inputs: test/pyproject/
+          # NOTE: We intentionally allow failure here, since the self-test
+          # explicitly uses a vulnerable requirements file.
+          internal-be-careful-allow-failure: true
+      - name: assert expected output
+        env:
+          PIP_AUDIT_OUTPUT: "${{ steps.pip-audit.outputs.internal-be-careful-output }}"
+        run: |
+          grep -E 'pyyaml\s+5.1' <<< $(base64 -d <<< "${PIP_AUDIT_OUTPUT}")
diff --git a/Dockerfile b/Dockerfile
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
diff --git a/Makefile b/Makefile
@@ -12,6 +12,6 @@ dev: env/pyvenv.cfg
 
 .PHONY: lint
 lint: env/pyvenv.cfg action.py
+	./env/bin/python -m black action.py
 	./env/bin/python -m isort action.py
 	./env/bin/python -m flake8 --max-line-length 100 action.py
-	./env/bin/python -m black action.py