UCL-ARC / UCL-ARC/python-tooling

`tests/data/test_package_generation` fails every new year as the year is hardcoded

Aperta
#507 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug
Lingua principale
Python
Stelle
62
Fork
10
Merge medio
7g 6h
PR unite (30g)
6

Descrizione

Describe the Bug

Every year the regression test will generate a package based on the current year when the test files will have the previous year

To Reproduce

Wait until a new year and watch tests fail on a PR

Expected Behaviour

Ideally we could either ignore the year or update the year somehow with @renovatebot or something

Actual Behaviour
  ============================= test session starts ==============================
  platform linux -- Python 3.12.8, pytest-8.3.4, pluggy-1.5.0 -- /home/runner/work/python-tooling/python-tooling/.tox/py312/bin/python
  cachedir: .tox/py312/.pytest_cache
  rootdir: /home/runner/work/python-tooling/python-tooling
  configfile: pyproject.toml
  collecting ... collected 8 items
  
  tests/data/test_package_generation/tests/test_dummy.py::test_stupid_example PASSED [ 12%]
  tests/test_git_init.py::test_initialisation_of_git_repo[True] PASSED     [ 25%]
  tests/test_git_init.py::test_initialisation_of_git_repo[False] PASSED    [ 37%]
  tests/test_package_generation.py::test_package_generation FAILED         [ 50%]
  tests/test_package_generation.py::test_pip_installable PASSED            [ 62%]
  tests/test_package_generation.py::test_optional_funder[] PASSED          [ 75%]
  tests/test_package_generation.py::test_optional_funder[STFC] PASSED      [ 87%]
  {{cookiecutter.project_slug}}/tests/test_dummy.py::test_stupid_example PASSED [100%]
  
  =================================== FAILURES ===================================
  ___________________________ test_package_generation ____________________________
  
  tmp_path = PosixPath('/tmp/pytest-of-runner/pytest-0/test_package_generation0')
  generate_package = <function _generate_package at 0x7fa89eb311c0>
  
      def test_package_generation(
          tmp_path: pathlib.Path,
          generate_package: typing.Callable,
      ) -> None:
          """Test package generation."""
          test_config = {
              "github_owner": "test-user",
              "project_short_description": "description",
              "project_name": "Cookiecutter Test",
              # Not having a git repo makes it easier to check in/out reference
              # data files to the main python-tooling git repository
              "initialise_git_repository": False,
          }
          generate_package(config=test_config, path=tmp_path)
      
          expected_package_dir = (
              pathlib.Path(__file__).parent / "data" / "test_package_generation"
          )
          # Check project directory exists
          test_project_dir = tmp_path / "cookiecutter-test"
          assert test_project_dir.exists()
      
          actual_files = get_all_files_folders(test_project_dir)
          expected_files = get_all_files_folders(expected_package_dir)
      
          assert actual_files == expected_files
      
          # Check diff between actual and expected file contents
          diff = ""
          for file in actual_files:
              actual_file = test_project_dir / file
              expected_file = expected_package_dir / file
      
              if actual_file.is_dir():
                  continue
      
              with actual_file.open() as f1, expected_file.open() as f2:
                  diff += "".join(
                      difflib.unified_diff(
                          f1.readlines(),
                          f2.readlines(),
                          fromfile=str(actual_file),
                          tofile=str(expected_file),
                      )
                  )
      
          if diff:
              shutil.rmtree(expected_package_dir)
              shutil.move(test_project_dir, expected_package_dir)
              msg = (
                  "Non-zero diff between generated files and expected files.\n"
                  "Test data files have been modified with new content.\n"
                  "Diff is:\n"
                  f"{diff}"
              )
  >           raise RuntimeError(msg)
  E           RuntimeError: Non-zero diff between generated files and expected files.
  E           Test data files have been modified with new content.
  E           Diff is:
  E           --- /tmp/pytest-of-runner/pytest-0/test_package_generation0/cookiecutter-test/mkdocs.yml
  E           +++ /home/runner/work/python-tooling/python-tooling/tests/data/test_package_generation/mkdocs.yml
  E           @@ -1,7 +1,7 @@
  E            site_name: "Cookiecutter Test"
  E            site_description: "Documentation website for Cookiecutter Test"
  E            site_author: "Eva Lu Ator"
  E           -copyright: "Copyright © 2025 Eva Lu Ator"
  E           +copyright: "Copyright © 2024 Eva Lu Ator"
  E            repo_url: "https://github.com/test-user/cookiecutter-test/"
  E            repo_name: "test-user/cookiecutter-test"
  E            edit_uri: edit/main/docs/
  E           --- /tmp/pytest-of-runner/pytest-0/test_package_generation0/cookiecutter-test/LICENSE.md
  E           +++ /home/runner/work/python-tooling/python-tooling/tests/data/test_package_generation/LICENSE.md
  E           @@ -1,6 +1,6 @@
  E            <!-- markdownlint-disable MD041 --># MIT License
  E            
  E           -Copyright (c) 2025 Eva Lu Ator
  E           +Copyright (c) 2024 Eva Lu Ator
  E            
  E            Permission is hereby granted, free of charge, to any person obtaining a copy of

Version In Use

v1.0.0

Additional Context

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Start with tests/test_package_generation.py and the reference files under tests/data/test_package_generation. Run the package-generation test and inspect the year differences in mkdocs.yml and LICENSE.md. Done means the generated package and expected data remain consistent when the calendar year changes.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
testing-qa, tooling
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.