snapctl 0.48.0__tar.gz → 0.48.1__tar.gz

{snapctl-0.48.0 → snapctl-0.48.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.48.0
+Version: 0.48.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -640,8 +640,12 @@ snapctl snapend clone --game-id $game_id --name $snapend_name --env $env --manif
 
 #### 4. Apply Snapend Changes
 
-Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. This is to prevent
-a user stomping over someone elses changes. Passing the blocking flag ensures your CLI command waits till the update is complete.
+Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. Basically, when you download a manifest, Snapser adds an `applied_configuration` section to your manifest, which stores the state of the Snapend during export. Now, if someone manually updates the Snapend or a configuration of a Snap, you are no longer going to have the latest Snapend representation in the `applied_configuration`. This is how Snapser prevents you from stomping over someone elses changes.
+
+You can optionally pass a `--force` flag telling Snapser to ignore any diffs it may find in the current state of the Snapend and the one in the `applied_configuration` field of your manifest. Essentially, this flag allows you to stomp over any changes and tell Snapser to force apply.
+
+Separately, you can pass a blocking flag to make your CLI wait for the Snapend update to complete.
+
 
 ```bash
 # Help for the apply command
@@ -649,10 +653,12 @@ snapctl snapend apply --help
 
 # Apply changes to a snapend via manifest
 # $path_to_manifest = Path to the manifest file; should include the file name
+# --force = Optional flag to tell Snapser that you do not want it to check the diff between the Snapend states and just force apply the changes
 # Example:
-# snapctl snapend apply --manifest-path-filename "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+# snapctl snapend apply --manifest-path-filename "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --force --blocking
 snapctl snapend apply --manifest-path-filename "$path_to_manifest"
 snapctl snapend apply --manifest-path-filename "$path_to_manifest" --blocking
+snapctl snapend apply --manifest-path-filename "$path_to_manifest" --force --blocking
 ```
 
 #### 5. Update Snapend BYOSnap or BYOGs versions

{snapctl-0.48.0 → snapctl-0.48.1}/README.md

@@ -620,8 +620,12 @@ snapctl snapend clone --game-id $game_id --name $snapend_name --env $env --manif
 
 #### 4. Apply Snapend Changes
 
-Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. This is to prevent
-a user stomping over someone elses changes. Passing the blocking flag ensures your CLI command waits till the update is complete.
+Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. Basically, when you download a manifest, Snapser adds an `applied_configuration` section to your manifest, which stores the state of the Snapend during export. Now, if someone manually updates the Snapend or a configuration of a Snap, you are no longer going to have the latest Snapend representation in the `applied_configuration`. This is how Snapser prevents you from stomping over someone elses changes.
+
+You can optionally pass a `--force` flag telling Snapser to ignore any diffs it may find in the current state of the Snapend and the one in the `applied_configuration` field of your manifest. Essentially, this flag allows you to stomp over any changes and tell Snapser to force apply.
+
+Separately, you can pass a blocking flag to make your CLI wait for the Snapend update to complete.
+
 
 ```bash
 # Help for the apply command
@@ -629,10 +633,12 @@ snapctl snapend apply --help
 
 # Apply changes to a snapend via manifest
 # $path_to_manifest = Path to the manifest file; should include the file name
+# --force = Optional flag to tell Snapser that you do not want it to check the diff between the Snapend states and just force apply the changes
 # Example:
-# snapctl snapend apply --manifest-path-filename "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+# snapctl snapend apply --manifest-path-filename "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --force --blocking
 snapctl snapend apply --manifest-path-filename "$path_to_manifest"
 snapctl snapend apply --manifest-path-filename "$path_to_manifest" --blocking
+snapctl snapend apply --manifest-path-filename "$path_to_manifest" --force --blocking
 ```
 
 #### 5. Update Snapend BYOSnap or BYOGs versions

{snapctl-0.48.0 → snapctl-0.48.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snapctl"
-version = "0.48.0"
+version = "0.48.1"
 description = "Snapser CLI Tool"
 authors = ["Ajinkya Apte <aj@snapser.com>"]
 readme = "README.md"

{snapctl-0.48.0 → snapctl-0.48.1}/snapctl/commands/snapend.py

@@ -18,7 +18,8 @@ from snapctl.config.constants import SERVER_CALL_TIMEOUT, SNAPCTL_INPUT_ERROR, \
     SNAPCTL_SNAPEND_APPLY_ERROR, SNAPCTL_SNAPEND_PROMOTE_SERVER_ERROR, \
     SNAPCTL_SNAPEND_PROMOTE_TIMEOUT_ERROR, SNAPCTL_SNAPEND_PROMOTE_ERROR, \
     SNAPCTL_SNAPEND_DOWNLOAD_ERROR, SNAPCTL_SNAPEND_UPDATE_TIMEOUT_ERROR, \
-    SNAPCTL_SNAPEND_UPDATE_ERROR, SNAPCTL_SNAPEND_STATE_ERROR
+    SNAPCTL_SNAPEND_UPDATE_ERROR, SNAPCTL_SNAPEND_STATE_ERROR, HTTP_ERROR_SNAPEND_MANIFEST_MISMATCH, \
+    SNAPCTL_SNAPEND_APPLY_MANIFEST_MISMATCH_ERROR
 from snapctl.config.hashes import PROTOS_TYPES, CLIENT_SDK_TYPES, SERVER_SDK_TYPES, \
     SNAPEND_MANIFEST_TYPES, SDK_TYPES, SDK_ACCESS_AUTH_TYPE_LOOKUP
 from snapctl.utils.echo import error, success, info
@@ -57,6 +58,7 @@ class Snapend:
         env: Union[str, None] = None,
         # Clone, Apply, Promote
         manifest_path_filename: Union[str, None] = None,
+        force: bool = False,
         # Download
         category: Union[str, None] = None,
         category_format: Union[str, None] = None,
@@ -78,6 +80,7 @@ class Snapend:
         self.name: str = name
         self.env: str = env
         self.manifest_path_filename: Union[str, None] = manifest_path_filename
+        self.force: bool = force
         self.category: str = category
         self.portal_category: Union[str, None] = Snapend._make_portal_category(
             category_format)
@@ -598,14 +601,17 @@ class Snapend:
                 payload = {
                     'ext': self.manifest_file_name.split('.')[-1]
                 }
+                if self.force is True:
+                    info('Force flag is set. Ignoring manifest diff.')
+                    payload['ignore_diff'] = 'true'
                 url = f"{self.base_url}/v1/snapser-api/snapends/snapend-manifest"
                 res = requests.put(
                     url, headers={'api-key': self.api_key},
                     files=files, data=payload, timeout=SERVER_CALL_TIMEOUT
                 )
+                response = res.json()
                 if res.ok:
                     # extract the cluster ID
-                    response = res.json()
                     if 'cluster' not in response or 'id' not in response['cluster']:
                         snapctl_error(
                             message='Server Error. Unable to get a Snapend ID. '
@@ -643,6 +649,13 @@ class Snapend:
                         f"{response['cluster']['id']}`",
                         progress=progress
                     )
+                else:
+                    if "api_error_code" in response and "message" in response:
+                        if response['api_error_code'] == HTTP_ERROR_SNAPEND_MANIFEST_MISMATCH:
+                            snapctl_error(
+                                message='Remote manifest does not match the manifest in the applied_configuration field.',
+                                code=SNAPCTL_SNAPEND_APPLY_MANIFEST_MISMATCH_ERROR, progress=progress
+                            )
         except RequestException as e:
             snapctl_error(
                 message=f"Unable to apply the manifest snapend. {e}",

{snapctl-0.48.0 → snapctl-0.48.1}/snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = 'beta-'
-VERSION = '0.48.0'
+VERSION = '0.48.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -27,6 +27,7 @@ HTTP_ERROR_SERVICE_VERSION_EXISTS = 542
 HTTP_ERROR_SERVICE_IN_USE = 543
 HTTP_ERROR_TAG_NOT_AVAILABLE = 544
 HTTP_ERROR_ADD_ON_NOT_ENABLED = 547
+HTTP_ERROR_SNAPEND_MANIFEST_MISMATCH = 594
 
 # CLI Return Codes
 SNAPCTL_SUCCESS = 0
@@ -102,6 +103,7 @@ SNAPCTL_SNAPEND_UPDATE_ERROR = 72
 SNAPCTL_SNAPEND_UPDATE_SERVER_ERROR = 73
 SNAPCTL_SNAPEND_UPDATE_TIMEOUT_ERROR = 74
 SNAPCTL_SNAPEND_STATE_ERROR = 75
+SNAPCTL_SNAPEND_APPLY_MANIFEST_MISMATCH_ERROR = 76
 
 # Generate Errors - 80 - 85
 SNAPCTL_GENERATE_GENERIC_ERROR = 80

{snapctl-0.48.0 → snapctl-0.48.1}/snapctl/main.py

@@ -546,6 +546,10 @@ def snapend(
         None, "--manifest-path-filename",
         help="(req: apply|clone) Full Path to the manifest file including the filename."
     ),
+    force: bool = typer.Option(
+        False, "--force",
+        help="(optional: apply) If true, Snapser will ignore the configuration diff validation and allow to force apply the manifest."
+    ),
     # download
     category: str = typer.Option(
         None, "--category",
@@ -646,6 +650,7 @@ def snapend(
         name=name, env=env,
         # Apply, Clone
         manifest_path_filename=manifest_path_filename,
+        force=force,
         # Download
         category=category,
         category_format=category_format,