support pixi environments (#42)

* refactor `spec` into a separate submodule

* dispatch by kind

* default the kind to `conda`

* adapt the tests

* configure project metadata

* add `manifest_path` to the cli options

* formatting

* write the environment parsing for pixi envs

* raise a more descriptive error if no suitable releases were found

* filter out excluded packages before fetching releases

* consider unpinned specs as not matching

* gracefully handle unpinned but not ignored dependencies

* install the module instead of modifying `sys.path`

* allow passing `manifest-path` to the action

* misformatted input definition

* stop testing on the unsupported python 3.10

* install the package itself

* use the warning style for unpinned versions

* warn about ignored PyPI dependencies

* tests for most of the functions in `minimum_versions.release`

* tests for the environment functions

* tests for parsing conda specs

* also check parsing the entire conda env

* rename

* check parsing pixi specs

* fix a bug in the lower pin regex

* additional spec parsing checks

* check invalid versions raise

* checks for parse_pixi_environment

* include the default feature in the features

* rename the `environment-paths` input to `environments`

* describe how to analyze `pixi` environments

* rename `env-paths` to `envs`

* e2e tests for pixi and mixed envs

* typo

* add policy files for the pixi tests

* another typo

* quotes and expected failure settings

* add a failing pixi env

* also check the default pypi-dependencies

* back to `python=3.9`

* support the `no-default-feature` option

* support analyzing missing features

* change the error text for unknown version specs

* add a note containing the package name

* add more information

* support dict pins

* configure coverage

* check the format detection

* raise on unknown features

* support no features

* check that `<=` is also detected

* check pypi dependencies

* support local packages

* skip the local package, if any

* properly check that local packages are skipped

* add information about the environments

Author: keewis

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.11", "3.12", "3.13"]
 
     steps:
       - name: clone the repository
@@ -31,6 +31,7 @@ jobs:
       - name: install dependencies
         run: |
           python -m pip install -r requirements.txt
+          python -m pip install .
           python -m pip install pytest
       - name: run tests
         run: |
@@ -43,7 +44,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        env-paths:
+        envs:
           - "envs/env1.yaml"
           - "envs/env2.yaml"
           - |
@@ -52,18 +53,38 @@ jobs:
         expected-failure: ["false"]
         policy-file: ["policy.yaml"]
         include:
-          - env-paths: |
+          - envs: |
               envs/failing-env1.yaml
             policy-file: "policy.yaml"
             expected-failure: "true"
-          - env-paths: |
+          - envs: |
               envs/env1.yaml
               envs/failing-env1.yaml
             policy-file: "policy.yaml"
             expected-failure: "true"
-          - env-paths: "envs/env1.yaml"
-            policy-file: policy_no_extra_options.yaml
+          - envs: "envs/env1.yaml"
+            policy-file: "policy_no_extra_options.yaml"
             expected-failure: "false"
+          - envs: "pixi:env1"
+            manifest-path: "envs/pixi.toml"
+            policy-file: "policy.yaml"
+            expected-failure: "false"
+          - envs: |
+              pixi:env1
+              pixi:env2
+            manifest-path: "envs/pixi.toml"
+            policy-file: "policy.yaml"
+            expected-failure: "false"
+          - envs: |
+              pixi:env1
+              conda:envs/env2.yaml
+            manifest-path: "envs/pixi.toml"
+            policy-file: "policy.yaml"
+            expected-failure: "false"
+          - envs: "pixi:failing-env"
+            manifest-path: "envs/pixi.toml"
+            policy-file: "policy.yaml"
+            expected-failure: "true"
 
     steps:
       - name: clone the repository
@@ -74,8 +95,9 @@ jobs:
         continue-on-error: true
         with:
           policy: ${{ matrix.policy-file }}
-          environment-paths: ${{ matrix.env-paths }}
+          environments: ${{ matrix.envs }}
           today: 2024-12-20
+          manifest-path: ${{ matrix.manifest-path }}
       - name: detect outcome
         if: always()
         shell: bash -l {0}

README.md

@@ -42,7 +42,13 @@ them to an empty mapping or sequence, respectively:
   ignored_violations: []
 ```
 
-Then add a new step to CI:
+Then add a new step to CI.
+
+### conda
+
+To analyze conda environments, simply pass the path to the environment file (`env.yaml`) to the `environments` key.
+
+The conda environment file _must_ specify exactly the `conda-forge` channel.
 
 ```yaml
 jobs:
@@ -53,7 +59,7 @@ jobs:
     - uses: xarray-contrib/minimum-dependency-versions@version
       with:
         policy: policy.yaml
-        environment-paths: path/to/env.yaml
+        environments: path/to/env.yaml
 ```
 
 To analyze multiple environments at the same time, pass a multi-line string:
@@ -67,8 +73,63 @@ jobs:
 
     - uses: xarray-contrib/minimum-dependency-versions@version
       with:
-        environment-paths: |
+        environments: |
           path/to/env1.yaml
           path/to/env2.yaml
-          path/to/env3.yaml
+          conda:path/to/env3.yaml  # the conda: prefix is optional
+```
+
+### pixi
+
+To analyze pixi environments, specify the environment name prefixed with `pixi:` and point to the manifest file using `manifest-path`.
+
+Any environment must pin the dependencies, which must be exact pins (i.e. `x.y.*` or `>=x.y.0,<x.(y + 1).0`, with the former being strongly encouraged). Lower pins are interpreted as exact pins, while all other forms of pinning are not allowed.
+
+```yaml
+jobs:
+  my-job:
+    ...
+    steps:
+    ...
+
+    - uses: xarray-contrib/minimum-dependency-versions@version
+      with:
+        environments: pixi:env1
+        manifest-path: /path/to/pixi.toml  # or pyproject.toml
+```
+
+Multiple environments can be analyzed at the same time:
+
+```yaml
+jobs:
+  my-job:
+    ...
+    steps:
+    ...
+
+    - uses: xarray-contrib/minimum-dependency-versions@version
+      with:
+        environments: |
+          pixi:env1
+          pixi:env2
+        manifest-path: /path/to/pixi.toml  # or pyproject.toml
+```
+
+### Mixing environment types
+
+It is even possible to mix environment types (once again, the `conda:` prefix is optional but recommended):
+
+```yaml
+jobs:
+  my-job:
+    ...
+    steps:
+    ...
+
+    - uses: xarray-contrib/minimum-dependency-versions@version
+      with:
+        environments: |
+          pixi:env1
+          conda:path/to/env.yaml
+        manifest-path: path/to/pixi.toml  # or pyproject.toml
 ```

action.yaml

@@ -7,18 +7,24 @@ inputs:
       The path to the policy to follow
     required: true
     type: string
-  environment-paths:
+  today:
+    description: >-
+      Time machine for testing
+    required: false
+    type: string
+  environments:
     description: >-
-      The paths to the environment files
+      The names or paths of the environments. Pixi environment names must be
+      prefixed with `pixi:`. Conda environment paths may be prefixed with
+      `conda:`. If there is no prefix, it is assumed to be a conda env path.
     required: true
     type: list
-  today:
+  manifest-path:
     description: >-
-      Time machine for testing
+      Path to the manifest file of `pixi`. Required for `pixi` environments.
     required: false
     type: string
 outputs: {}
-
 runs:
   using: "composite"
 
@@ -28,14 +34,20 @@ runs:
       run: |
         echo "::group::Install dependencies"
         python -m pip install -r ${{ github.action_path }}/requirements.txt
+        python -m pip install ${{ github.action_path }}
         echo "::endgroup::"
     - name: analyze environments
       shell: bash -l {0}
       env:
         COLUMNS: 120
         FORCE_COLOR: 3
         POLICY_PATH: ${{ inputs.policy }}
-        ENVIRONMENT_PATHS: ${{ inputs.environment-paths }}
+        ENVIRONMENTS: ${{ inputs.environments }}
         TODAY: ${{ inputs.today }}
+        MANIFEST_PATH: ${{ inputs.manifest-path }}
       run: |
-        PYTHONPATH=${{github.action_path}} python -m minimum_versions validate --today="$TODAY" --policy="$POLICY_PATH" $ENVIRONMENT_PATHS
+        python -m minimum_versions validate \
+          --today="$TODAY" \
+          --policy="$POLICY_PATH" \
+          --manifest-path="$MANIFEST_PATH" \
+          $ENVIRONMENTS

envs/pixi.toml

@@ -0,0 +1,17 @@
+[dependencies]
+pandas = "2.1"
+packaging = "23.1"
+
+[feature.py39.dependencies]
+python = "3.9"
+
+[feature.py310.dependencies]
+python = "3.10"
+
+[feature.failing.dependencies]
+numpy = "2.1"
+
+[environments]
+env1 = { features = ["py310"] }
+env2 = ["py39"]
+failing-env = { features = ["failing"] }

minimum_versions/environments/__init__.py

@@ -0,0 +1,25 @@
+import pathlib
+
+from minimum_versions.environments.conda import parse_conda_environment
+from minimum_versions.environments.pixi import parse_pixi_environment
+from minimum_versions.environments.spec import Spec, compare_versions  # noqa: F401
+
+kinds = {
+    "conda": parse_conda_environment,
+    "pixi": parse_pixi_environment,
+}
+
+
+def parse_environment(specifier: str, manifest_path: pathlib.Path | None) -> list[Spec]:
+    split = specifier.split(":", maxsplit=1)
+    if len(split) == 1:
+        kind = "conda"
+        path = specifier
+    else:
+        kind, path = split
+
+    parser = kinds.get(kind)
+    if parser is None:
+        raise ValueError(f"Unknown kind {kind!r}, extracted from {specifier!r}.")
+
+    return parser(path, manifest_path)

minimum_versions/environments/conda.py

@@ -0,0 +1,46 @@
+import pathlib
+
+import yaml
+from rattler import Version
+
+from minimum_versions.environments.spec import Spec
+
+
+def parse_spec(spec_text):
+    warnings = []
+    if ">" in spec_text or "<" in spec_text:
+        warnings.append(
+            f"package must be pinned with an exact version: {spec_text!r}."
+            " Using the version as an exact pin instead."
+        )
+
+        spec_text = spec_text.replace(">", "").replace("<", "")
+
+    if "=" in spec_text:
+        name, version_text = spec_text.split("=", maxsplit=1)
+        version = Version(version_text)
+        segments = version.segments()
+
+        if (len(segments) == 3 and segments[2] != [0]) or len(segments) > 3:
+            warnings.append(
+                f"package should be pinned to a minor version (got {version})"
+            )
+    else:
+        name = spec_text
+        version = None
+
+    return Spec(name, version), (name, warnings)
+
+
+def parse_conda_environment(path: pathlib.Path, manifest_path: None):
+    env = yaml.safe_load(pathlib.Path(path).read_text())
+
+    specs = []
+    warnings = []
+    for dep in env["dependencies"]:
+        spec, warnings_ = parse_spec(dep)
+
+        specs.append(spec)
+        warnings.append(warnings_)
+
+    return specs, warnings