Adding name convention validator for QHub project name

.github/workflows/test-provider.yaml

@@ -79,7 +79,7 @@ jobs:
           pip install .[dev]
       - name: QHub Initialize
         run: |
-          qhub init "${{ matrix.provider }}" --project "test--${{ matrix.provider }}-${{ matrix.cicd }}" --domain "${{ matrix.provider }}.qhub.dev" --auth-provider github --disable-prompt --ci-provider ${{ matrix.cicd }}
+          qhub init "${{ matrix.provider }}" --project "TestProvider" --domain "${{ matrix.provider }}.qhub.dev" --auth-provider github --disable-prompt --ci-provider ${{ matrix.cicd }}
           cat "qhub-config.yaml"
       - name: QHub Render
         run: |

qhub/schema.py

@@ -428,14 +428,13 @@ def enabled_must_have_fields(cls, values):
 
 
 # ==================== Main ===================
-
 letter_dash_underscore_pydantic = pydantic.constr(regex=namestr_regex)
 
 
 class Main(Base):
-    project_name: letter_dash_underscore_pydantic
-    namespace: typing.Optional[letter_dash_underscore_pydantic]
     provider: ProviderEnum
+    project_name: str
+    namespace: typing.Optional[letter_dash_underscore_pydantic]
     qhub_version: str = ""
     ci_cd: typing.Optional[CICD]
     domain: str
@@ -485,6 +484,45 @@ def check_default(cls, v):
     def is_version_accepted(cls, v):
         return v != "" and rounded_ver_parse(v) == rounded_ver_parse(__version__)
 
+    @validator("project_name")
+    def project_name_convention(cls, value: typing.Any, values):
+        convention = """
+        In order to successfully deploy QHub, there are some project naming conventions which need
+        to be followed. First, ensure your name is compatible with the specific one for
+        your chosen Cloud provider. In addition, the QHub project name should also obey the following
+        format requirements:
+        - Letters from A to Z (upper and lower case) and numbers;
+        - Maximum accepted length of the name string is 16 characters.
+        - If using AWS: names should not start with the string "aws";
+        - If using Azure: names should not contain "-".
+        """
+        if len(value) > 16:
+            raise ValueError(
+                "\n".join(
+                    [
+                        convention,
+                        "Maximum accepted length of the project name string is 16 characters.",
+                    ]
+                )
+            )
+        elif values["provider"] == "azure" and ("-" in value):
+            raise ValueError(
+                "\n".join(
+                    [convention, "Provider [azure] does not allow '-' in project name."]
+                )
+            )
+        elif values["provider"] == "aws" and value.startswith("aws"):
+            raise ValueError(
+                "\n".join(
+                    [
+                        convention,
+                        "Provider [aws] does not allow 'aws' as starting sequence in project name.",
+                    ]
+                )
+            )
+        else:
+            return letter_dash_underscore_pydantic
+
 
 def verify(config):
     return Main(**config)