zarr-python/.github/workflows/hypothesis.yaml at 5b5f3a3e690c9e74cebf86952606c8bb21ac2dfa · zarr-developers/zarr-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
name: Slow Hypothesis CI
on:
  push:
    branches: [main, 3.1.x]
  pull_request:
    branches: [main, 3.1.x]
    types: [opened, reopened, synchronize, labeled]
  schedule:
    - cron: "0 0 * * *" # Daily “At 00:00” UTC
  workflow_dispatch: # allows you to trigger manually

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  FORCE_COLOR: 3
  # Use the uv from astral-sh/setup-uv instead of hatch's bundled (pyapp) uv.
  HATCH_ENV_TYPE_VIRTUAL_UV_PATH: uv

jobs:

  hypothesis:
    name: Slow Hypothesis Tests
    permissions:
      contents: read
      issues: write
    environment:
      name: codecov-upload
      deployment: false
    runs-on: "ubuntu-latest"
    defaults:
      run:
        shell: bash -l {0}

    strategy:
      matrix:
        python-version: ['3.12']
        dependency-set: ["optional"]

    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      with:
        persist-credentials: false
    - name: Set HYPOTHESIS_PROFILE based on trigger
      env:
        EVENT_NAME: ${{ github.event_name }}
      run: |
        if [[ "$EVENT_NAME" == "schedule" || "$EVENT_NAME" == "workflow_dispatch" ]]; then
          echo "HYPOTHESIS_PROFILE=nightly" >> $GITHUB_ENV
        else
          echo "HYPOTHESIS_PROFILE=ci" >> $GITHUB_ENV
        fi
    - name: Set up Python
      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
      with:
        python-version: ${{ matrix.python-version }}
        cache: 'pip'
    - name: Install uv
      uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
    - name: Install Hatch
      uses: pypa/hatch@f647ed70d49adb885f53a27d1c7f5bdaeacf2c60
      with:
        version: '1.16.5'
    - name: Set Up Hatch Env
      env:
        HATCH_ENV: test.py${{ matrix.python-version }}-${{ matrix.dependency-set }}
      run: |
        hatch env create "$HATCH_ENV"
        hatch env run -e "$HATCH_ENV" list-env
    # https://github.com/actions/cache/blob/main/tips-and-workarounds.md#update-a-cache
    - name: Restore cached hypothesis directory
      id: restore-hypothesis-cache
      uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
      with:
        path: .hypothesis/
        key: cache-hypothesis-${{ runner.os }}-${{ github.run_id }}
        restore-keys: |
          cache-hypothesis-

    - name: Run slow Hypothesis tests
      if: success()
      id: status
      env:
        HATCH_ENV: test.py${{ matrix.python-version }}-${{ matrix.dependency-set }}
        PYTEST_ADDOPTS: "--report-log=output-${{ matrix.python-version }}-log.jsonl"
      run: |
        echo "Using Hypothesis profile: $HYPOTHESIS_PROFILE"
        hatch env run --env "$HATCH_ENV" run-hypothesis

    # explicitly save the cache so it gets updated, also do this even if it fails.
    - name: Save cached hypothesis directory
      id: save-hypothesis-cache
      if: always() && steps.status.outcome != 'skipped'
      uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
      with:
        path: .hypothesis/
        key: cache-hypothesis-${{ runner.os }}-${{ github.run_id }}

    - name: Upload coverage
      uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        flags: tests
        verbose: true # optional (default = false)

    - name: Generate and publish the report
      if: |
        failure()
        && steps.status.outcome == 'failure'
        && github.event_name == 'schedule'
        && github.repository_owner == 'zarr-developers'
      uses: scientific-python/issue-from-pytest-log-action@35b4e0a9e06f8e7e261778289cf4b968b722662d # v1.6.2
      with:
        log-path: output-${{ matrix.python-version }}-log.jsonl
        issue-title: "Nightly Hypothesis tests failed"
        issue-label: "automated issue"