Merge branch 'main' into v-dmshib/add-check-latest

dmitry-shibanov · Jul 25, 2022 · May 4, 2022 · May 6, 2022 · May 9, 2022 · May 9, 2022
commit de4dd601ce47ae8bf6c6f99db846ac0c7dc12ba5
diff --git a/.github/workflows/e2e-cache.yml b/.github/workflows/e2e-cache.yml
@@ -39,7 +39,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.9', 'pypy-3.7-v7.x']
+        python-version: ['3.9', 'pypy-3.9-v7.x']
     steps:
       - uses: actions/checkout@v3
       - name: Setup Python
@@ -48,11 +48,17 @@ jobs:
           python-version: ${{ matrix.python-version }}
           cache: 'pipenv'
       - name: Install pipenv
-        run: pipx install pipenv
+        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
       - name: Install dependencies
+        shell: pwsh
         run: |
-          cd __tests__/data
-          pipenv install --verbose
+          mv ./__tests__/data/Pipfile.lock .
+          mv ./__tests__/data/Pipfile .
+          if ("${{ matrix.python-version }}" -Match "pypy") {
+            pipenv install --keep-outdated --python pypy
+          } else {
+            pipenv install --keep-outdated --python ${{ matrix.python-version }}
+          }
 
   python-poetry-dependencies-caching:
     name: Test poetry (Python ${{ matrix.python-version}}, ${{ matrix.os }})
@@ -102,7 +108,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.9', 'pypy-3.7-v7.x']
+        python-version: ['3.9', 'pypy-3.9-v7.x']
     steps:
       - uses: actions/checkout@v3
       - name: Setup Python
@@ -112,8 +118,14 @@ jobs:
           cache: 'pipenv'
           cache-dependency-path: '**/pipenv-requirements.txt'
       - name: Install pipenv
-        run: pipx install pipenv
+        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
       - name: Install dependencies
+        shell: pwsh
         run: |
-          cd __tests__/data
-          pipenv install --verbose
+          mv ./__tests__/data/Pipfile.lock .
+          mv ./__tests__/data/Pipfile .
+          if ("${{ matrix.python-version }}" -Match "pypy") {
+            pipenv install --keep-outdated --python pypy
+          } else {
+            pipenv install --keep-outdated --python ${{ matrix.python-version }}
+          }
@@ -66,6 +66,32 @@ jobs:
           ${EXECUTABLE} --version
         shell: bash
 
+  setup-pypy-noenv:
+    name: Setup PyPy ${{ matrix.pypy }} ${{ matrix.os }} (noenv)
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-18.04, ubuntu-latest]
+        pypy: ['pypy2.7', 'pypy3.7', 'pypy3.8', 'pypy3.9-nightly']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: setup-python ${{ matrix.pypy }}
+        id: setup-python
+        uses: ./
+        with:
+          python-version: ${{ matrix.pypy }}
+          update-environment: false
+
+      - name: PyPy and Python version
+        run: ${{ steps.setup-python.outputs.python-path }} --version
+
+      - name: Run simple code
+        run: ${{ steps.setup-python.outputs.python-path }} -c 'import math; print(math.factorial(5))'
+
   check-latest:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -81,7 +107,7 @@ jobs:
           check-latest: true
       - name: PyPy and Python version
         run: python --version
-  
+
       - name: Run simple code
         run: python -c 'import math; print(math.factorial(5))'
 

@@ -148,6 +148,31 @@ jobs:
     - name: Run simple code
       run: python -c 'import math; print(math.factorial(5))'
 
+  setup-versions-noenv:
+    name: Setup ${{ matrix.python }} ${{ matrix.os }} (noenv)
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-18.04, ubuntu-20.04]
+        python: ["3.7", "3.8", "3.9", "3.10"]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: setup-python ${{ matrix.python }}
+      id: setup-python
+      uses: ./
+      with:
+        python-version: ${{ matrix.python }}
+        update-environment: false
+
+    - name: Python version
+      run: ${{ steps.setup-python.outputs.python-path }} --version
+
+    - name: Run simple code
+      run: ${{ steps.setup-python.outputs.python-path }} -c 'import math; print(math.factorial(5))'
+
   check-latest:
     runs-on: ${{ matrix.os }}
     strategy:

diff --git a/.licenses/npm/@actions/cache.dep.yml b/.licenses/npm/@actions/cache.dep.yml
diff --git a/.licenses/npm/@actions/http-client-2.0.1.dep.yml b/.licenses/npm/@actions/http-client-2.0.1.dep.yml
@@ -127,6 +127,26 @@ steps:
 - run: python my_script.py
 ```
 
+Download and set up the latest patch version of Python (for specified major & minor versions):
+```yaml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-python@v4
+  with:
+    python-version: '3.11-dev'
+- run: python my_script.py
+```
+
+Download and set up the latest stable version of Python (for specified major version):
+```yaml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-python@v4
+  with:
+    python-version: '3.x'
+- run: python my_script.py
+```
+
 Download and set up PyPy:
 
 ```yaml
@@ -287,12 +307,12 @@ steps:
 ```yaml
 steps:
 - uses: actions/checkout@v3
-- name: Install pipenv
-  run: pipx install pipenv
 - uses: actions/setup-python@v4
   with:
     python-version: '3.9'
     cache: 'pipenv'
+- name: Install pipenv
+  run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
 - run: pipenv install
 ```
 
@@ -326,18 +346,53 @@ steps:
 ```yaml
 steps:
 - uses: actions/checkout@v3
-- name: Install pipenv
-  run: pipx install pipenv
 - uses: actions/setup-python@v4
   with:
     python-version: '3.9'
     cache: 'pipenv'
     cache-dependency-path: |
       server/app/Pipfile.lock
       __test__/app/Pipfile.lock
+- name: Install pipenv
+  run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
 - run: pipenv install
 ```
 
+**Using a list of wildcard patterns to cache dependencies**
+```yaml
+steps:
+- uses: actions/checkout@v3
+- uses: actions/setup-python@v4
+  with:
+    python-version: '3.10'
+    cache: 'pip'
+    cache-dependency-path: |
+      **/setup.cfg
+      **/requirements*.txt
+- run: pip install -e . -r subdirectory/requirements-dev.txt
+```
+
+
+# Environment variables
+
+ The `update-environment` flag defaults to `true`.
+ With this setting, the action will add/update environment variables (e.g. `PATH`, `PKG_CONFIG_PATH`, `pythonLocation`) for `python` to just work out of the box.
+
+ If `update-environment` is set to `false`, the action will not add/update environment variables.
+ This can prove useful if you want the only side-effect to be to ensure python is installed and rely on the `python-path` output to run python.
+ Such a requirement on side-effect could be because you don't want your composite action messing with your user's workflows.
+
+ ```yaml
+ steps:
+   - uses: actions/checkout@v3
+   - uses: actions/setup-python@v4
+     id: cp310
+     with:
+       python-version: '3.10'
+       update-environment: false
+   - run: ${{ steps.cp310.outputs.python-path }} my_script.py
+ ```
+
 # Using `setup-python` with a self hosted runner
 
 Python distributions are only available for the same [environments](https://github.com/actions/virtual-environments#available-environments) that GitHub Actions hosted environments are available for. If you are using an unsupported version of Ubuntu such as `19.04` or another Linux distribution such as Fedora, `setup-python` will not work. If you have a supported self-hosted runner and you would like to use `setup-python`, there are a few extra things you need to make sure are set up so that new versions of Python can be downloaded and configured on your runner.
@@ -355,7 +410,7 @@ If you are experiencing problems while configuring Python on your self-hosted ru
 ### Linux
 
 - The Python packages that are downloaded from `actions/python-versions` are originally compiled from source in `/opt/hostedtoolcache/` with the [--enable-shared](https://github.com/actions/python-versions/blob/94f04ae6806c6633c82db94c6406a16e17decd5c/builders/ubuntu-python-builder.psm1#L35) flag, which makes them non-relocatable.
-- Create an environment variable called `AGENT_TOOLSDIRECTORY` and set it to `/opt/hostedtoolcache`. This controls where the runner downloads and installs tools.
+- By default runner downloads and install the tools to `/opt/hostedtoolcache`. The environment variable called `AGENT_TOOLSDIRECTORY` can be set to change this location.
   - In the same shell that your runner is using, type `export AGENT_TOOLSDIRECTORY=/opt/hostedtoolcache`.
   - A more permanent way of setting the environment variable is to create a `.env` file in the same directory as your runner and to add `AGENT_TOOLSDIRECTORY=/opt/hostedtoolcache`. This ensures the variable is always set if your runner is configured as a service.
 - Create a directory called `hostedtoolcache` inside `/opt`.
@@ -384,14 +439,7 @@ If you are experiencing problems while configuring Python on your self-hosted ru
 
 `setup-python` comes pre-installed on the appliance with GHES if Actions is enabled. When dynamically downloading Python distributions, `setup-python` downloads distributions from [`actions/python-versions`](https://github.com/actions/python-versions) on github.com (outside of the appliance). These calls to `actions/python-versions` are made via unauthenticated requests, which are limited to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting). If more requests are made within the time frame, then you will start to see rate-limit errors during download that read `##[error]API rate limit exceeded for...`.
 
-To get a higher rate limit, you can [generate a personal access token on github.com](https://github.com/settings/tokens/new) and pass it as the `token` input for the action:
-
-```yml
-uses: actions/setup-python@v4
-with:
-  token: ${{ secrets.GH_DOTCOM_TOKEN }}
-  python-version: 3.11
-```
+To avoid hitting rate-limit problems, we recommend [setting up your own runner tool cache](https://docs.github.com/en/enterprise-server@2.22/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access#about-the-included-setup-actions-and-the-runner-tool-cache).
 
 # License
 

diff --git a/__tests__/cache-restore.test.ts b/__tests__/cache-restore.test.ts
@@ -5,7 +5,7 @@ import {getCacheDistributor} from '../src/cache-distributions/cache-factory';
 
 describe('restore-cache', () => {
   const pipFileLockHash =
-    'd1dd6218299d8a6db5fc2001d988b34a8b31f1e9d0bb4534d377dde7c19f64b3';
+    'a3bdcc71289e4979ca9e051810d81999cc99823109faf6912e17ff14c8e621a6';
   const requirementsHash =
     'd8110e0006d7fb5ee76365d565eef9d37df1d11598b912d3eb66d398d57a1121';
   const requirementsLinuxHash =

diff --git a/__tests__/cache-save.test.ts b/__tests__/cache-save.test.ts
@@ -212,6 +212,59 @@ describe('run', () => {
       );
       expect(setFailedSpy).not.toHaveBeenCalled();
     });
+
+    it('saves with -1 cacheId , should not fail workflow', async () => {
+      inputs['cache'] = 'poetry';
+      getStateSpy.mockImplementation((name: string) => {
+        if (name === State.STATE_CACHE_PRIMARY_KEY) {
+          return poetryLockHash;
+        } else if (name === State.CACHE_PATHS) {
+          return JSON.stringify([__dirname]);
+        } else {
+          return requirementsHash;
+        }
+      });
+
+      saveCacheSpy.mockImplementation(() => {
+        return -1;
+      });
+
+      await run();
+
+      expect(getInputSpy).toHaveBeenCalled();
+      expect(getStateSpy).toHaveBeenCalledTimes(3);
+      expect(infoSpy).not.toHaveBeenCalled();
+      expect(saveCacheSpy).toHaveBeenCalled();
+      expect(infoSpy).not.toHaveBeenLastCalledWith(
+        `Cache saved with the key: ${poetryLockHash}`
+      );
+      expect(setFailedSpy).not.toHaveBeenCalled();
+    });
+
+    it('saves with error from toolkit, should fail workflow', async () => {
+      inputs['cache'] = 'npm';
+      getStateSpy.mockImplementation((name: string) => {
+        if (name === State.STATE_CACHE_PRIMARY_KEY) {
+          return poetryLockHash;
+        } else if (name === State.CACHE_PATHS) {
+          return JSON.stringify([__dirname]);
+        } else {
+          return requirementsHash;
+        }
+      });
+
+      saveCacheSpy.mockImplementation(() => {
+        throw new cache.ValidationError('Validation failed');
+      });
+
+      await run();
+
+      expect(getInputSpy).toHaveBeenCalled();
+      expect(getStateSpy).toHaveBeenCalledTimes(3);
+      expect(infoSpy).not.toHaveBeenCalledWith();
+      expect(saveCacheSpy).toHaveBeenCalled();
+      expect(setFailedSpy).toHaveBeenCalled();
+    });
   });
 
   afterEach(() => {

diff --git a/__tests__/data/Pipfile b/__tests__/data/Pipfile
@@ -4,8 +4,8 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-numpy = "1.22.3"
-pandas = "1.4.2"
+flake8 = "==4.0.1"
+numpy = "==1.23.0"
 
 [dev-packages]