Made optional the need of passing a project when initializing Calm fo… (

#252) Made optional the need of passing a project when initializing Calm-DSL. --------- Co-authored-by: Abhijeet Kaurav <[email protected]> (cherry picked from commit 2a97bb69c2d10ac0ae03cf97d26e581a4d0a6222)
nutanix · Aug 8, 2023 · 32ea9e8 · 32ea9e8
1 parent a95e61a
commit 32ea9e8
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 26 deletions.
diff --git a/calm/dsl/builtins/models/blueprint_payload.py b/calm/dsl/builtins/models/blueprint_payload.py
@@ -1,11 +1,17 @@
+import sys
+
 from calm.dsl.config import get_context
+from calm.dsl.constants import DSL_CONFIG
+from calm.dsl.log import get_logging_handle
 
 from .entity import EntityType, Entity
 from .validator import PropertyValidator
 from .blueprint import BlueprintType
 from .simple_blueprint import SimpleBlueprintType
 from .calm_ref import Ref
 
+LOG = get_logging_handle(__name__)
+
 
 # Blueprint Payload
 
@@ -61,6 +67,10 @@ def create_blueprint_payload(UserBlueprint, metadata={}):
     #  Project will be taken from config if not provided
     if not metadata.get("project_reference", {}):
         project_name = project_config["name"]
+        if project_name == DSL_CONFIG.EMPTY_PROJECT_NAME:
+            LOG.error(DSL_CONFIG.EMPTY_PROJECT_MESSAGE)
+            sys.exit("Invalid project configuration")
+
         metadata["project_reference"] = Ref.Project(project_name)
 
     #  User will be taken from config if not provided

diff --git a/calm/dsl/cli/bps.py b/calm/dsl/cli/bps.py
@@ -47,7 +47,7 @@
 from calm.dsl.builtins import Brownfield as BF
 from calm.dsl.providers import get_provider
 from calm.dsl.providers.plugins.ahv_vm.main import AhvNew
-from calm.dsl.constants import CACHE
+from calm.dsl.constants import CACHE, DSL_CONFIG
 from calm.dsl.log import get_logging_handle
 from calm.dsl.builtins.models.calm_ref import Ref
 
@@ -326,6 +326,10 @@ def compile_blueprint(bp_file, brownfield_deployment_file=None):
             ]
         else:
             project_name = project_config["name"]
+            if project_name == DSL_CONFIG.EMPTY_PROJECT_NAME:
+                LOG.error(DSL_CONFIG.EMPTY_PROJECT_MESSAGE)
+                sys.exit("Invalid project configuration")
+
             bp_payload["metadata"]["project_reference"] = Ref.Project(project_name)
     else:
         if isinstance(UserBlueprint, type(VmBlueprint)):

diff --git a/calm/dsl/cli/init_command.py b/calm/dsl/cli/init_command.py
@@ -19,7 +19,7 @@
 from calm.dsl.init import init_bp, init_runbook
 from calm.dsl.providers import get_provider_types
 from calm.dsl.store import Version
-from calm.dsl.constants import POLICY, STRATOS
+from calm.dsl.constants import POLICY, STRATOS, DSL_CONFIG
 
 from .main import init, set
 from calm.dsl.log import get_logging_handle
@@ -158,7 +158,9 @@ def set_server_details(
     port = port or click.prompt("Port", default="9440")
     username = username or click.prompt("Username", default="admin")
     password = password or click.prompt("Password", default="", hide_input=True)
-    project_name = project_name or click.prompt("Project", default="default")
+    project_name = project_name or click.prompt(
+        "Project", default=DSL_CONFIG.EMPTY_PROJECT_NAME
+    )
 
     # Default log-level
     log_level = "INFO"
@@ -250,15 +252,15 @@ def set_server_details(
     else:
         LOG.debug("Stratos is not supported")
         stratos_status = False
-
-    LOG.info("Verifying the project details")
-    project_name_uuid_map = client.project.get_name_uuid_map(
-        params={"filter": "name=={}".format(project_name)}
-    )
-    if not project_name_uuid_map:
-        LOG.error("Project '{}' not found !!!".format(project_name))
-        sys.exit(-1)
-    LOG.info("Project '{}' verified successfully".format(project_name))
+    if project_name != DSL_CONFIG.EMPTY_PROJECT_NAME:
+        LOG.info("Verifying the project details")
+        project_name_uuid_map = client.project.get_name_uuid_map(
+            params={"filter": "name=={}".format(project_name)}
+        )
+        if not project_name_uuid_map:
+            LOG.error("Project '{}' not found !!!".format(project_name))
+            sys.exit(-1)
+        LOG.info("Project '{}' verified successfully".format(project_name))
 
     # Writing configuration to file
     set_dsl_config(
@@ -455,7 +457,7 @@ def _set_config(
     password = password or server_config["pc_password"]
 
     project_config = ContextObj.get_project_config()
-    project_name = project_name or project_config.get("name") or "default"
+    project_name = project_name or project_config.get("name")
 
     LOG.info("Checking if Calm is enabled on Server")
 
@@ -533,14 +535,15 @@ def _set_config(
         LOG.debug("Stratos is not supported")
         stratos_status = False
 
-    LOG.info("Verifying the project details")
-    project_name_uuid_map = client.project.get_name_uuid_map(
-        params={"filter": "name=={}".format(project_name)}
-    )
-    if not project_name_uuid_map:
-        LOG.error("Project '{}' not found !!!".format(project_name))
-        sys.exit(-1)
-    LOG.info("Project '{}' verified successfully".format(project_name))
+    if project_name != DSL_CONFIG.EMPTY_PROJECT_NAME:
+        LOG.info("Verifying the project details")
+        project_name_uuid_map = client.project.get_name_uuid_map(
+            params={"filter": "name=={}".format(project_name)}
+        )
+        if not project_name_uuid_map:
+            LOG.error("Project '{}' not found !!!".format(project_name))
+            sys.exit(-1)
+        LOG.info("Project '{}' verified successfully".format(project_name))
 
     log_config = ContextObj.get_log_config()
     log_level = log_level or log_config.get("level") or "INFO"

diff --git a/calm/dsl/cli/main.py b/calm/dsl/cli/main.py
@@ -14,6 +14,7 @@
 from calm.dsl.log import get_logging_handle
 from calm.dsl.config import get_context
 from calm.dsl.store import Cache
+from calm.dsl.constants import DSL_CONFIG
 
 from .version_validator import validate_version
 from .click_options import simple_verbosity_option, show_trace_option
@@ -75,6 +76,14 @@ def main(ctx, config_file, sync):
     if config_file:
         ContextObj = get_context()
         ContextObj.update_config_file_context(config_file=config_file)
+
+    ContextObj = get_context()
+    project_config = ContextObj.get_project_config()
+    project_name = project_config.get("name")
+
+    if project_name == DSL_CONFIG.EMPTY_PROJECT_NAME:
+        LOG.warning(DSL_CONFIG.EMPTY_PROJECT_MESSAGE)
+
     if sync:
         Cache.sync()
 

diff --git a/calm/dsl/cli/runbooks.py b/calm/dsl/cli/runbooks.py
@@ -25,7 +25,7 @@
 from calm.dsl.api import get_api_client
 from calm.dsl.log import get_logging_handle
 from calm.dsl.builtins.models.calm_ref import Ref
-from calm.dsl.constants import CACHE
+from calm.dsl.constants import CACHE, DSL_CONFIG
 from calm.dsl.store import Cache
 from calm.dsl.tools import get_module_from_file
 from .utils import (
@@ -160,6 +160,10 @@ def compile_runbook(runbook_file):
         ]
     else:
         project_name = project_config["name"]
+        if project_name == DSL_CONFIG.EMPTY_PROJECT_NAME:
+            LOG.error(DSL_CONFIG.EMPTY_PROJECT_MESSAGE)
+            sys.exit("Invalid project configuration")
+
         runbook_payload["metadata"]["project_reference"] = Ref.Project(project_name)
 
     return runbook_payload

diff --git a/calm/dsl/config/context.py b/calm/dsl/config/context.py
@@ -4,6 +4,7 @@
 from .env_config import EnvConfig
 from .config import get_config_handle
 from calm.dsl.log import get_logging_handle
+from calm.dsl.constants import DSL_CONFIG
 
 LOG = get_logging_handle(__name__)
 
@@ -100,10 +101,7 @@ def get_project_config(self):
 
         config = self.project_config
         if not config.get("name"):
-            LOG.warning(
-                "Default project not found in config file or environment('CALM_DSL_DEFAULT_PROJECT' variable). Setting it to 'default' project"
-            )
-            config["name"] = "default"
+            config["name"] = DSL_CONFIG.EMPTY_PROJECT_NAME
 
         return config
 

diff --git a/calm/dsl/constants.py b/calm/dsl/constants.py
@@ -178,3 +178,8 @@ class OPENAPI_TYPE:
         GCP = "app_gcp_account"
         CREDENTIAL_PROVIDER = "app_credential_provider_account"
         CUSTOM_PROVIDER = "app_custom_provider_account"
+
+
+class DSL_CONFIG:
+    EMPTY_PROJECT_NAME = "-"
+    EMPTY_PROJECT_MESSAGE = "Project configuration not available. Use command `calm set config -pj <project_name>` to set it."