Adding name convention validator for QHub project name

[viniciusdc]

In short, as QHub utilizes different cloud providers each one has a number of constraints that must be considered while naming resources. Because of that, QHub currently uses some naming conventions to better address these outstanding restrictions. Using this validator we will avoid issues with QHub deployment as well give more feedback to the end user.

QHub naming convetion used as base.

close #626

[tylerpotts]

Edited text for grammar/tone.

Using ALL CAPS FEELS LIKE YELLING :)

Also, the phrase "for starters" has connotations that there's a big list of things incoming, and sends the wrong message when indicating the user did something wrong (this could be a person preference thing)

Also suggested edits to allow - in the names

[tylerpotts]

Where does this come from? It looks like the current aws test has a project name aws-test

This is causing the AWS tests to fail

[viniciusdc]

It is the description... but I don't remember why we need to avoid that. I remember a discussion about that a really long time ago... Anyways I will need to add another step in that validation because the Azure storage name must not contain any dashes

[viniciusdc]

@tarundmsharma so right now this regex is not considering all dashes in the project name, which is not something we would like to have for all providers... only for Azure. So we need to add a conditional that checks the target provider and use the correct regex based on it.

[costrouc]

@tarundmsharma this PR is failing due to the tests having aws in the project name in the beginning. For example https://github.com/Quansight/qhub/blob/main/tests/test_render.py#L11. I'd suggest renaming all the project names in tests to pytest-<provider> instead of <pytest>-provider this way the tests will pass.

[tarundmsharma]

sure @costrouc, thanks for the direction. ill check. but logically thinking, i had tried PR for only the code which had validator for azure, still the tests failed. can it be because of "-". if yes then do i have to do any further changes to eliminate the failure because of "-".

[costrouc]

@viniciusdc and @tarundmsharma I'm not sure what this regular expression is meant to do. Could you explain?

[tarundmsharma]

this part of code is checking the project name can have A-Z, a-z, 0-9 and special character, if the project name contains characters beyond the list. error will be given during the deployments.

[viniciusdc]

Hi @costrouc originally, this was the complete regex #761 (comment), it was supposed to return only strings that do NOT contain aws in the beginning of the project name as they are alphanumeric (not including extra characters). If one of those conditions do not hold, then the find all will return an empty list and an error will be raised. https://github.com/Quansight/qhub/blob/af8323ce27196254b88de065023fcbb60953d292/qhub/schema.py#L388

[costrouc]

I'd rather have a simple regex and rules for users on what can be in a project name so that we don't have to have so many exceptions. For example:

• must begin with a letter [a-z][A-Z]
• cannot have name begin with aws
• name can only contain [a-zA-Z0-9]

Can you make this the rule for checking? Is this sane?

[iameskild]

@viniciusdc once #927 is approved and merged, I can go back and resolve any merge conflicts here 👍

[viniciusdc]

I Forgot this, https://github.com/Quansight/qhub/blob/90e344810834038e10b22906ebb3222f29a405e2/qhub/template/hooks/pre_gen_project.py#L9

Same here
https://github.com/Quansight/qhub/blob/90e344810834038e10b22906ebb3222f29a405e2/qhub/initialize.py#L280

[iameskild]

@viniciusdc this is ready for another review when you get the chance, thanks :)

[viniciusdc]

This is now up-to-date with main, though this now requires a review of our naming conventions to continue. I will open a tracking issue to research this and update here once finished.

[costrouc]

@viniciusdc could you update the tests?