Integration tests for tools by fblanchetNaN · Pull Request #43 · NotANameServer/incipyt

fblanchetNaN · 2022-07-02T17:07:11Z

Integration tests for basic tools: setuptools, venv and git.

PR enabled to check all tests on the CI server, DO NOT MERGE yet.

Update versions for CI (GitHub Actions and pre-commit).

codecov-commenter · 2022-07-02T20:54:37Z

Codecov Report

Merging #43 (397edbc) into main (932e250) will increase coverage by 30.59%.
The diff coverage is 91.66%.

@@             Coverage Diff             @@
##             main      #43       +/-   ##
===========================================
+ Coverage   60.97%   91.56%   +30.59%     
===========================================
  Files          13       13               
  Lines         574      593       +19     
===========================================
+ Hits          350      543      +193     
+ Misses        224       50      -174

Impacted Files	Coverage Δ
incipyt/tools/git.py	`90.69% <90.47%> (+90.69%)`	⬆️
incipyt/__main__.py	`85.33% <100.00%> (+85.33%)`	⬆️
incipyt/_internal/templates.py	`89.37% <0.00%> (+0.62%)`	⬆️
incipyt/commands.py	`93.10% <0.00%> (+24.13%)`	⬆️
incipyt/_internal/sanitizers.py	`76.92% <0.00%> (+76.92%)`	⬆️
incipyt/tools/setuptools.py	`97.91% <0.00%> (+97.91%)`	⬆️
incipyt/signals.py	`100.00% <0.00%> (+100.00%)`	⬆️
incipyt/tools/base.py	`100.00% <0.00%> (+100.00%)`	⬆️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 932e250...397edbc. Read the comment docs.

Julien00859

We should be careful inside integration test, e.g. for that git config --global user.name, IMO we should mock those values before running the tests.

Please, don't store the truth inside of targz archives, it makes it impossible to read/diff on github

tests/test_tools/test_setuptools.py

Julien00859 · 2022-07-03T12:37:03Z

tests/test_tools/test_setuptools.py

+from incipyt.tools.setuptools import LINUX_MIN_PYTHON_VERSION
+
+
+def make_archive():


missing docstring, this test-file will be our integration-test showcase/template, it needs to be documented so people feel easy using it as a template for their own tests

and please note: I understand nothing at this function, what the fuck is an isolated_filesystem? why the fuck you need to chdir and remove a targz file???

where this function is used?

Julien00859 · 2022-07-03T12:58:52Z

tests/test_tools/test_setuptools.py

+        shutil.unpack_archive(
+            pathlib.Path(__file__).parent / "setuptools.tar.gz", "archive"
+        )


I've just noticed that the "truth" is inside a tar.gz file tests/test_tools/setuptools.tar.gz. I think it is a bad idea, if one day we change something to the setuptools plugin, we'll have to adapt this tgz file but we won't have a clear diff of what changed.

Today's me want to read (inside github) what's inside that tgz file, future's me want to read a diff (inside github) of what changed inside that tgz file. Please don't store it as a tgz, just upload the whole folder as-is.

Julien00859 · 2022-07-03T13:00:18Z

tests/test_tools/testing.py

+
+
+def diff_files(dircmp):
+    result = {str(pathlib.Path(dircmp.left) / f) for f in dircmp.diff_files}


Julien00859 · 2022-07-03T13:01:09Z

tests/test_tools/testing.py

+from incipyt import project
+
+
+def diff_files(dircmp):


what type is dircmp?

Julien00859 · 2022-07-03T13:07:44Z

tests/test_tools/testing.py

+        path
+        for path in result
+        if not any(
+            re.match(pattern, path) for pattern in [r".*/\.env/.*", r".*/dist/.*"]


let's use or own .gitignore https://stackoverflow.com/a/22090594

while I agree those need to be stored somewhere else (a list of globs, just as .gitignore does, is just fine), using incipyt own .gitignore seems ankward and error-prone to me

also, I'm not sure a 3rd party lib is really needed when we already have glob in the stdlib

Julien00859 · 2022-07-03T13:10:34Z

incipyt/tools/git.py

+        self._set_git_credential_email = False
+        self._set_git_credential_name = False


git doesn't use credentials, github does. user.name and user.email are not credentials

a name that starts with a verb should be a function, not a boolean

Julien00859 · 2022-07-03T13:38:09Z

incipyt/tools/git.py

        :param workon: Work-on folder.
        :type workon: :class:`pathlib.Path`
        """
+        if self._set_git_credential_email:


ok now I understand.

So the commit message should be:

feat(git): user.name defaults to AUTHOR_NAME Make sure there is no global git user.name and user.email: make sure `git config --global user.name` is empty, same of `user.email`. Create a project using git and setuptools: the wizard prompts you for an author name and email as it couldn't determine them via git. When the project is created, the author name and email are set inside `setup.cfg` but the local git configuration still lacks an user.name and a user.email. In this commit when no git user name or email is set globally and that one was provided to the wizard, it automatically update the config of the new git repository to set the user.name and the user.email to the AUTHOR_NAME and AUTHOR_EMAIL.

LeMinaw · 2022-07-04T09:40:17Z

first integration tests failing on windows CI is due to non platform-agnostic path matching at testing.py:23

(diff is + {'my_project\\.env\\pyvenv.cfg'} which should be ignored)

Julien00859 · 2022-07-04T14:10:53Z

incipyt/tools/git.py

        :param workon: Work-on folder.
        :type workon: :class:`pathlib.Path`
        """
+        git_user_email_return = commands.run(


I would isolate the "update git config" in a dedicated function

also amend the docstring

Julien00859 · 2022-07-04T14:20:12Z

incipyt/tools/git.py

+                    commands.run(
+                        [
+                            "git",
+                            "-C",
+                            os.fspath(workon),
+                            "config",
+                            "user.email",
+                            project.environ["AUTHOR_EMAIL"],
+                        ]
+                    )


I veto that.

Running $ git -C {} config user.email {} shouldn't expand over 9 lines of code.

def git(args, workon, **kwargs): args = ["git", "-C", os.fspath(workon), *args] return commands.run(args, **kwargs) git = partial(git, workon=workon)

This work include two new utilities, one to create a `StringTemplate` out of a file located inside of the new `/templates` directory, the other to copy a template file directly to the project.

A software license is a file stored at the root of a project which explain what it is allowed to do with the project source code and under what conditions. e.g. a project is qualified as "open-source" when it is published with a license that allows to distribute and modify the project source code. Until now the license file generated by incipyt was a simple copyright notice which made it explicit that the current work was the intellectual property of its owner. Under internationnal laws, this forbid anyone from modifying the work without the express authorization of the author. In this work, we added a way so that the user can choose an open-source license instead of the copyright notice. We added `--license <license>` to the CLI arguments and bundled common open-source licenses such as MIT and GPL. The previous behavior, to simply include a copyright notice, is still possible thanks to `--license copyright`.

See https://docs.pytest.org/en/latest/how-to/fixtures.html#yield-fixtures-recommended pytest recommends using a yield construction to setup and teardown environments for tests. Here we use it to clean project.environ and project.structure to provide reliable initial project in any case.

fblanchetNaN force-pushed the test_tools branch 2 times, most recently from 9c7318d to 5c3bab9 Compare July 2, 2022 20:52

fblanchetNaN force-pushed the test_tools branch from 5c3bab9 to 718ce55 Compare July 2, 2022 20:59

Julien00859 requested changes Jul 3, 2022

View reviewed changes

fblanchetNaN force-pushed the test_tools branch 2 times, most recently from 328f61f to 397edbc Compare July 3, 2022 16:35

Julien00859 reviewed Jul 4, 2022

View reviewed changes

Julien00859 changed the base branch from main to 20230402 April 2, 2023 13:13

fblanchetNaN and others added 11 commits April 2, 2023 15:20

chore(dev): migrate from flakeheaven to ruff + clean CI workflows

9401afd

feat: copy template files to project

6f67d36

This work include two new utilities, one to create a `StringTemplate` out of a file located inside of the new `/templates` directory, the other to copy a template file directly to the project.

feat(git): include a generic gitignore

933d5b9

feat(setuptools): keep classifiers and deps sorted

3f73a90

fix(lint): ignore rules related to abstact classes

64d4f63

fix(git): use empty author when git config fail

61ef17e

feat(git): prompt user to set git config user.name

19c4a6d

test: integration test for setuptools/venv

31757fe

test: integration test for git

cd5b361

Julien00859 force-pushed the test_tools branch from 397edbc to cd5b361 Compare April 2, 2023 16:59

fblanchetNaN force-pushed the merge-2023-04-02 branch 7 times, most recently from d2cd54a to 12736ae Compare April 8, 2023 00:52

Julien00859 force-pushed the merge-2023-04-02 branch from 12736ae to 90a2f4e Compare April 9, 2023 12:14

fblanchetNaN force-pushed the merge-2023-04-02 branch from 90a2f4e to 387fbda Compare April 9, 2023 12:47

		from incipyt.tools.setuptools import LINUX_MIN_PYTHON_VERSION


		def make_archive():



		def diff_files(dircmp):
		result = {str(pathlib.Path(dircmp.left) / f) for f in dircmp.diff_files}

		self._set_git_credential_email = False
		self._set_git_credential_name = False

Conversation

fblanchetNaN commented Jul 2, 2022

Uh oh!

codecov-commenter commented Jul 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Julien00859 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Julien00859 Jul 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Julien00859 Jul 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LeMinaw commented Jul 4, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Jul 2, 2022 •

edited

Loading

Julien00859 Jul 3, 2022 •

edited

Loading

Julien00859 Jul 3, 2022 •

edited

Loading