Issue/3110 modules v2 moduletool commands #3473

sanderr · 2021-11-18T14:20:14Z

Description

Reviewed all moduletool commands for v2 compatibility.

closes #3110

Self Check:

Strike through any lines that are not applicable (~~line~~) then check the box

Attached issue to pull request
Changelog entry
Type annotations are present
Code is clear and sufficiently documented
No (preventable) type errors (check using make mypy or make mypy-diff)
~~Sufficient test cases (reproduces the bug/tests the requested feature)~~
Correct, in line with design
~~End user documentation is included or an issue is created for end-user documentation (add ref to issue here: )~~

Reviewer Checklist:

Sufficient test cases (reproduces the bug/tests the requested feature)
Code is clear and sufficiently documented
Correct, in line with design

src/inmanta/module.py

arnaudsjs · 2021-11-19T07:20:32Z

src/inmanta/moduletool.py

+                raise Exception(f"Directory {module_dir} already exists")
+            cookiecutter(
+                "https://github.com/inmanta/inmanta-module-template.git",
+                checkout="v2",


Shouldn't we perform a checkout from master? The intention is to have the V2 template on the master branch after the release, no? It looks like no v2 branch exist at the moment. Was this functionality tested?

I expect we will need the V1 a little longer until we have set up the proper distribution channels for v2 modules.

I'd discussed both this and #3473 (comment) with Wouter yesterday but I'd forgotten to share the conclusions. The main reason we need to keep v1 on master for now is that new v2 modules require a v2 std, which we haven't decided how to distribute yet. The v2 branch does not exist yet but this is part of inmanta/inmanta-module-template#13.

arnaudsjs · 2021-11-19T07:45:27Z

src/inmanta/moduletool.py

+                matches = version == reqv
+                editable = True
+            else:
+                reqv = ",".join(req.version_spec_str() for req in specs[name] if req.specs) or "*"


The usage of reqv is inconsistent between V1 and V2 modules.

For V1 modules, reqv contains a list of version that match the version spec

For V2 modules, reqv contains the version specs.

Isn't this strange?

I agree somewhat strange, though both Wouter and I are of the opinion that the v2 format is an improvement. I opted to stick with the stricter approach for v1 because it needs to take the compiler version into account, making it more complex than just the version specs. We could clean that up as well but I'm not sure it's worth the effort for v1.
A small remark though, for v1 modules, if I understand correctly, it never contains a list, always a single version: the latest version with a compatible compiler version constraint.

arnaudsjs · 2021-11-19T07:46:29Z

src/inmanta/moduletool.py


            version_length = max(len(version), len(reqv), version_length)

-            table.append((name, version, reqv, version == reqv))
+            table.append((name, generation, editable, version, reqv, matches))


The version_length variable is not used anywhere. We can clean that up in my opinion.

arnaudsjs

See review comments.

wouterdb

Why no testcases?

wouterdb · 2021-11-18T14:24:21Z

changelogs/unreleased/3110-modules-v2-moduletool-commands.yml

+description: Reviewed all moduletool commands for v2 compatibility
+change-type: major
+sections:
+  deprecation-note: "The `inmanta module list -r` command has been deprecated"


Perhaps also mention the alternative

wouterdb · 2021-11-19T08:48:57Z

src/inmanta/moduletool.py

+                raise Exception(f"Directory {module_dir} already exists")
+            cookiecutter(
+                "https://github.com/inmanta/inmanta-module-template.git",
+                checkout="v2",


I expect we will need the V1 a little longer until we have set up the proper distribution channels for v2 modules.

Co-authored-by: arnaudsjs <2684622+arnaudsjs@users.noreply.github.com>

wouterdb

testcases! (I comment so you can re-request when you are done)

sanderr · 2021-11-19T14:24:37Z

Also from the demo meeting:

check matches behavior for release mode master has not been changed by this PR
mention deprecation in inmanta module list --help output
Generation -> module type
1/0 -> yes/no

…m:inmanta/inmanta-core into issue/3110-modules-v2-moduletool-commands

sanderr · 2021-11-22T16:49:40Z

Re-requesting review because of fundamental changes:

Dropped --force-reinstall from module install command as discussed on slack. Modified test cases to be compatible.
Extended Project.requires to include v2 requirements from requirements.txt

Non-fundamental changes:

added tests
suggestions from demo (see my comment above)

src/inmanta/moduletool.py

wouterdb · 2021-11-23T11:47:34Z

tests/moduletool/test_install.py

+    )
+
+    cwd = os.getcwd()
+    try:


Why is this?

This was meant to wrap the whole block below, but apparently it's not required because snippetcompiler does Project.set. I'll remove it.

inmantaci · 2021-11-23T12:08:52Z

Processing this pull request

inmantaci · 2021-11-23T12:09:00Z

Merged into branches master in b27d170

# Description Reviewed all moduletool commands for v2 compatibility. closes #3110 # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [x] Attached issue to pull request - [x] Changelog entry - [x] Type annotations are present - [x] Code is clear and sufficiently documented - [x] No (preventable) type errors (check using make mypy or make mypy-diff) - [x] ~~Sufficient test cases (reproduces the bug/tests the requested feature)~~ - [x] Correct, in line with design - [x] ~~End user documentation is included or an issue is created for end-user documentation (add ref to issue here: )~~ # Reviewer Checklist: - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Code is clear and sufficiently documented - [ ] Correct, in line with design

sanderr added 2 commits November 18, 2021 11:13

partial moduletool commands compatibility with v2 modules

b60dff5

updated more moduletool commands

2674cc7

sanderr requested review from wouterdb and arnaudsjs November 18, 2021 14:20

module create command checkout v2 branch of module template

29d4ebd

arnaudsjs reviewed Nov 19, 2021

View reviewed changes

arnaudsjs requested changes Nov 19, 2021

View reviewed changes

wouterdb requested changes Nov 19, 2021

View reviewed changes

sanderr and others added 4 commits November 19, 2021 09:59

Update src/inmanta/module.py

4442790

Co-authored-by: arnaudsjs <2684622+arnaudsjs@users.noreply.github.com>

removed unused variables

c67b9f6

expanded deprecation note

e77ffc8

pep8

6e66b68

sanderr requested review from wouterdb and arnaudsjs November 19, 2021 09:14

arnaudsjs approved these changes Nov 19, 2021

View reviewed changes

added tests for v2 incompatible commands

6a1a407

wouterdb reviewed Nov 19, 2021

View reviewed changes

sanderr added 10 commits November 22, 2021 11:56

added tests for v2 incompatible commands

b97b196

Merge branch 'issue/3110-modules-v2-moduletool-commands' of github.co…

a3cbe11

…m:inmanta/inmanta-core into issue/3110-modules-v2-moduletool-commands

added tests for module create

f9b3d56

implemented suggestions from demo

9aa1b87

added partial module list test

015174e

got rid of force-reinstall

9c3a55f

completed test case

c260154

Merge branch 'master' into issue/3110-modules-v2-moduletool-commands

b741c78

fixed project v2 constraints missing from list table

942d659

pep8

2ffbdcf

sanderr requested a review from wouterdb November 22, 2021 16:49

sanderr requested a review from arnaudsjs November 22, 2021 16:49

arnaudsjs requested changes Nov 23, 2021

View reviewed changes

src/inmanta/moduletool.py Show resolved Hide resolved

review comment

bb0df92

sanderr requested a review from arnaudsjs November 23, 2021 09:11

arnaudsjs approved these changes Nov 23, 2021

View reviewed changes

updated error messages to reflect new reinstall behavior

64d645a

wouterdb reviewed Nov 23, 2021

View reviewed changes

wouterdb approved these changes Nov 23, 2021

View reviewed changes

got rid of redundant directory change

2af1531

sanderr added the merge-tool-ready This ticket is ready to be merged in label Nov 23, 2021

inmantaci closed this Nov 23, 2021

inmantaci deleted the issue/3110-modules-v2-moduletool-commands branch November 23, 2021 12:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue/3110 modules v2 moduletool commands #3473

Issue/3110 modules v2 moduletool commands #3473

sanderr commented Nov 18, 2021

arnaudsjs Nov 19, 2021

wouterdb Nov 19, 2021

sanderr Nov 19, 2021

arnaudsjs Nov 19, 2021

sanderr Nov 19, 2021

arnaudsjs Nov 19, 2021

sanderr Nov 19, 2021

arnaudsjs left a comment

wouterdb left a comment

wouterdb Nov 18, 2021

sanderr Nov 19, 2021

wouterdb Nov 19, 2021

wouterdb left a comment

sanderr commented Nov 19, 2021

sanderr commented Nov 22, 2021

wouterdb Nov 23, 2021

sanderr Nov 23, 2021

inmantaci commented Nov 23, 2021

inmantaci commented Nov 23, 2021

Issue/3110 modules v2 moduletool commands #3473

Issue/3110 modules v2 moduletool commands #3473

Conversation

sanderr commented Nov 18, 2021

Description

Self Check:

Reviewer Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arnaudsjs left a comment

Choose a reason for hiding this comment

wouterdb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wouterdb left a comment

Choose a reason for hiding this comment

sanderr commented Nov 19, 2021

sanderr commented Nov 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

inmantaci commented Nov 23, 2021

inmantaci commented Nov 23, 2021