Skip to content

Fix parsing special characters in environment names for distribution.py #663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jnhealy2 merged 2 commits into from
Jul 28, 2026
Merged

Fix parsing special characters in environment names for distribution.py #663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d053cb
Fix parsing special characters in environment names for distribution.py
akimler Jul 27, 2026
cc05896
Merge branch 'main' into akimler/fix_env_special_chars
akimler Jul 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion manager/manager_cmds/distribution.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import fnmatch
import glob
import os
import re
import shutil
import tempfile
from pathlib import Path
Expand Down Expand Up @@ -169,7 +170,10 @@ def canonicalize_path(spath):


def valid_env_scopes(env):
scopes = spack.config.CONFIG.matching_scopes(f"^env:{env.name}|^include:")
env_name = getattr(env, "name", None)
escaped_env_name = re.escape(env_name)
pattern = f"^(env:{escaped_env_name}|include:)"
scopes = spack.config.CONFIG.matching_scopes(pattern)
return [s.name for s in scopes]


Expand Down
17 changes: 17 additions & 0 deletions tests/test_distribution.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,23 @@ def test_get_valid_env_scopes(tmpdir):
assert len(scope_names) == 2


def test_get_valid_env_scopes_escape_chars(tmpdir):
"""
Regression test: valid_env_scopes should match an environment scope even
when env.name contains regex-special characters.
"""
env_dir = os.path.join(tmpdir.strpath, "escape_char+_-=/*!~", "environment")
manifest = os.path.join(env_dir, "spack.yaml")

create_spack_manifest(manifest)

env = spack.environment.environment_from_name_or_dir(os.path.dirname(manifest))
with env:
scope_names = distribution.valid_env_scopes(env)

assert f"env:{env.name}" in scope_names


class MockArgs:
def __init__(self, source=False, binary=False):
self.source_only = source
Expand Down
Loading