Registry Module: Read Version Error Parsing Versions

[jhutchings]

python-tfe version

v0.1.1

Description

When attempting to use the Registry Module Read Version there appears to be an error in the String Checking for Version numbers. I initially thought it was due to using a Nightly tag on the module but in testing deployed versions they also are having issues.

In checking the code, it appears to be:

        if not valid_string(version) or not valid_string_id(version):
            raise ValueError(ERR_INVALID_VERSION)

valid_string_id function's regex is invalid for SemVer, perhaps valid_version function was meant to be used like in delete_version

        if not valid_string(version) or not valid_version(version):
            raise ValueError(ERR_INVALID_VERSION)

Testing plan

1. Created a module in Terraform Private Registry
2. Using TFE Token created a small client that just reads `client.registry_modules.read_version()`

    config = TFEConfig.from_env()
    client = TFEClient(config)

    module_id = RegistryModuleID(
            organization="Test-Org",
            registry_name=RegistryName.PRIVATE,
            name="module-example",
            provider="random"
        )

    read_version = client.registry_modules.read_version(
        module_id,
        "4.0.25"
    )

Expected Behavior

Returns a valid RegistryModuleVersion

Actual Behavior

Error message:

Reading Registry Module Version...
Traceback (most recent call last):
  File "/Users/user/Desktop/code/cloudeng/pytfe-test/main.py", line 32, in <module>
    main()
    ~~~~^^
  File "/Users/user/Desktop/code/cloudeng/pytfe-test/main.py", line 26, in main
    read_version = client.registry_modules.read_version(
        module_id,
        "v4.0.25"
    )
  File "/Users/user/Desktop/code/cloudeng/pytfe-test/.venv/lib/python3.14/site-packages/pytfe/resources/registry_module.py", line 203, in read_version
    raise ValueError(ERR_INVALID_VERSION)
ValueError: invalid value for version

Additional Context

No additional unusual behaviours

[isivaselvan]

@jhutchings , Thank you for reporting this! We have resolved the issue by updating the regex pattern for valid_string_id. The fix is scheduled for release 0.1.2.

[jhutchings]

One other thing I noticed in the Registry Modules is that there are some references still to the old URL bases, I was wondering if there was a variance in the REST API and that was why the old base was used instead or if it was a backlog for future updates?

Create Version:
https://github.com/hashicorp/python-tfe/blob/main/src/pytfe/resources/registry_module.py#L130
uses path = f"/api/v2/registry-modules/:organization_name/:name/:provider/versions"
instead of path=f"/api/v2/organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/versions

All Three Deletes:
https://github.com/hashicorp/python-tfe/blob/main/src/pytfe/resources/registry_module.py#L309-L344
POST /registry-modules/actions/delete/:organization_name/:name/:provider/:version
POST /registry-modules/actions/delete/:organization_name/:name/:provider
POST /registry-modules/actions/delete/:organization_name/:name
are replaced by the below endpoints and will be removed from future versions of the API

DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/:version
DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider
DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name

Should I create another issue for these so they can be backlogged (not critical fix vs. enhancements that you're already working on)

[iam404]

@jhutchings Thanks for reporting. Yes I will like to track the deprecating endpoints on seperate tickets and may be we will cover them in 1.4 or 2.0.