snapctl 0.48.0__py3-none-any.whl → 0.48.1__py3-none-any.whl

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/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/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,

{snapctl-0.48.0.dist-info → snapctl-0.48.1.dist-info}/METADATA

@@ -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.dist-info → snapctl-0.48.1.dist-info}/RECORD

@@ -6,9 +6,9 @@ snapctl/commands/byosnap.py,sha256=xfUlIMUkiIRi6uYbtGvVR6vM_buO-6KH_i1ay3sELJY,7
 snapctl/commands/game.py,sha256=nCXtEXAJkvOw26c_OBGr7Pz4hwu-5FXHyBR2kkXhLCM,5247
 snapctl/commands/generate.py,sha256=9-NlZVQllBT2LZT_t9S3ztwtHzTbM-C8_x0f6z70U3g,5606
 snapctl/commands/release_notes.py,sha256=K1OdX94pL-pKL2Depbs-AkVcPpKn_CX2cOsZiRZP5kc,2134
-snapctl/commands/snapend.py,sha256=ZQSI_QfxsmqCkz2kBkFSMN94ZkSgXlzwZBJXEs5nOoM,38483
+snapctl/commands/snapend.py,sha256=0Ygr3znXc_eu0sVt2YTznnUV4f_L8zjz3FtMSQMUwIY,39288
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=9qNitkpp08oNuEuPmHdQPpZ_P97R0CtIfiJVkNk2RQY,3500
+snapctl/config/constants.py,sha256=_5qHkmSUabspjkR8RykZ2WfNEts1kdIAV-YibpQGquU,3594
 snapctl/config/endpoints.py,sha256=9kllA79xn9G_aBLp1rohURZi93pwYzTEWZ8ObtZ6crw,338
 snapctl/config/hashes.py,sha256=2Dyb3lbNRNKzc80XUH8S4yNJtRVGRCMK7-GwzyT4WQ0,5149
 snapctl/data/profiles/snapser-byosnap-profile.json,sha256=c7oIzMJewVQaoLaXCBPXlH-k5cL9DCz6q4IixsWWD9c,2404
@@ -20,14 +20,14 @@ snapctl/data/releases/beta-0.47.0.mdx,sha256=p-bp0NUVcSKELHXtHJaq884_O4yTZDTCUbW
 snapctl/data/releases/beta-0.47.1.mdx,sha256=YqQ7ncHDW9pCbQNnQic1o_xQt3DinOFEo3YW0hJVUAk,645
 snapctl/data/releases/beta-0.47.2.mdx,sha256=9FQuJj6ntu0gG5Mf-d8lgCRqmzkuFyESqI_Gf5jLNmo,135
 snapctl/data/releases/beta-0.48.0.mdx,sha256=b9Dz-a2FAaZx2BnFTyle7PgJ2RuNv6Zj1KsT2TfaNH8,1244
-snapctl/main.py,sha256=xjJSSdAGWiYYYC20OumSMxYQODTEAHbRRfyBstFiiAI,22685
+snapctl/main.py,sha256=Or3zsN-4s7G-aJjOyJAtFh1pAvsI5MJjr6n018Lpg-Q,22906
 snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/types/definitions.py,sha256=EQzLeiXkJ8ISRlCqHMviNVsWWpmhWjpKaOBLdlvOTmY,644
 snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/utils/echo.py,sha256=V0qgjqqGXRiueMkq31enmNmdqciC8S90qGRcK8UupXA,1090
 snapctl/utils/helper.py,sha256=co6HhAE-Fo4TMxjSNZUfjK40vAwD3n8qU_JQcNjSlmU,6584
-snapctl-0.48.0.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-0.48.0.dist-info/METADATA,sha256=elOdGRY3YjNJkIcwTfFk0aG2suCGriS1S5vFUltcgwY,33843
-snapctl-0.48.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-0.48.0.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.48.0.dist-info/RECORD,,
+snapctl-0.48.1.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-0.48.1.dist-info/METADATA,sha256=5Pk1yvwIEQOgBHWqeeroI4A9zRAosh8A9FJQZuyb3Co,34727
+snapctl-0.48.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-0.48.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.48.1.dist-info/RECORD,,