snapctl 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

snapctl/commands/snapend_manifest.py

@@ -8,9 +8,9 @@ from requests.exceptions import RequestException
 from rich.progress import Progress, SpinnerColumn, TextColumn
 from snapctl.config.constants import SNAPCTL_SNAPEND_MANIFEST_UPGRADE_ERROR, SNAPCTL_INPUT_ERROR, \
     SNAPCTL_SNAPEND_MANIFEST_CREATE_ERROR, SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR, \
-    SNAPCTL_INTERNAL_SERVER_ERROR
+    SNAPCTL_INTERNAL_SERVER_ERROR, SNAPCTL_SNAPEND_MANIFEST_SYNC_ERROR
 from snapctl.commands.snaps import Snaps
-from snapctl.utils.helper import snapctl_error, snapctl_success
+from snapctl.utils.helper import snapctl_error, snapctl_success, check_duplicates_in_list
 from snapctl.utils.echo import info, warning, success
 
 
@@ -18,7 +18,7 @@ class SnapendManifest:
     """
       CLI commands exposed for Snapend manifest
     """
-    SUBCOMMANDS = ['create', 'update', 'upgrade']
+    SUBCOMMANDS = ['create', 'sync', 'update', 'upgrade']
     ENVIRONMENTS = ['DEVELOPMENT', 'STAGING', 'PRODUCTION']
     FEATURES = ['WEB_SOCKETS']
     AUTH_SNAP_ID = 'auth'
@@ -30,6 +30,10 @@ class SnapendManifest:
             manifest_path_filename: Union[str, None] = None,
             snaps: Union[str, None] = None,
             features: Union[str, None] = None,
+            add_snaps: Union[str, None] = None,
+            remove_snaps: Union[str, None] = None,
+            add_features: Union[str, None] = None,
+            remove_features: Union[str, None] = None,
             out_path_filename: Union[str, None] = None,
     ) -> None:
         self.subcommand: str = subcommand
@@ -42,6 +46,10 @@ class SnapendManifest:
         self.out_path_filename: Union[str, None] = out_path_filename
         self.snaps = snaps
         self.features = features
+        self.add_snaps = add_snaps
+        self.remove_snaps = remove_snaps
+        self.add_features = add_features
+        self.remove_features = remove_features
         self.remote_snaps: list = self.load_snaps()
         # Setup
         self.setup_manifest()
@@ -137,6 +145,12 @@ class SnapendManifest:
                     message="Environment must be one of " +
                     f"{', '.join(SnapendManifest.ENVIRONMENTS)}.",
                     code=SNAPCTL_INPUT_ERROR)
+            if (not self.snaps or self.snaps == '') and \
+                    (not self.features or self.features == ''):
+                snapctl_error(
+                    message="At least one of snaps or features " +
+                    "is required to sync a snapend manifest.",
+                    code=SNAPCTL_INPUT_ERROR)
             if not self.out_path_filename:
                 snapctl_error(
                     message="Output path is required for create command.",
@@ -147,33 +161,80 @@ class SnapendManifest:
                 snapctl_error(
                     message="Output path must end with .json, .yaml or .yml",
                     code=SNAPCTL_INPUT_ERROR)
-            if not self.snaps or self.snaps == '':
-                snapctl_error(
-                    message="At least one snap ID is required to create a " +
-                    "snapend manifest.",
-                    code=SNAPCTL_INPUT_ERROR)
+            if self.snaps and self.snaps != '':
+                input_snaps_list = self.snaps.split(',')
+                repeat_snaps = check_duplicates_in_list(input_snaps_list)
+                if len(repeat_snaps) > 0:
+                    snapctl_error(
+                        message="Duplicate snaps found in input: " +
+                        f"{', '.join(repeat_snaps)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                remote_snaps_ids = [snap['id'] for snap in self.remote_snaps]
+                for input_snap in input_snaps_list:
+                    if not input_snap in remote_snaps_ids:
+                        snapctl_error(
+                            message="Invalid Snap " + input_snap +
+                            " provided with --snaps. Please check and try again.",
+                            code=SNAPCTL_INPUT_ERROR)
             if self.features:
-                for feature in self.features.split(','):
+                input_features_list = self.features.split(',')
+                repeat_features = check_duplicates_in_list(input_features_list)
+                if len(repeat_features) > 0:
+                    snapctl_error(
+                        message="Duplicate features found in input: " +
+                        f"{', '.join(repeat_features)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                for feature in input_features_list:
                     feature = feature.strip()
                     if feature.upper() not in SnapendManifest.FEATURES:
                         snapctl_error(
-                            message="-add-features must be one of " +
+                            message="--features must be one of " +
                             f"{', '.join(SnapendManifest.FEATURES)}.",
                             code=SNAPCTL_INPUT_ERROR)
-        elif self.subcommand == 'update':
+        elif self.subcommand == 'sync':
             if not self.manifest_path_filename:
                 snapctl_error(
-                    message="Manifest path is required for update command.",
+                    message="Manifest path is required for sync command.",
                     code=SNAPCTL_INPUT_ERROR)
             if (not self.snaps or self.snaps == '') and \
                     (not self.features or self.features == ''):
                 snapctl_error(
                     message="At least one of snaps or features " +
-                    "is required to update a snapend manifest.",
+                    "is required to sync a snapend manifest.",
                     code=SNAPCTL_INPUT_ERROR)
+            if self.snaps and self.snaps != '':
+                input_snaps_list = self.snaps.split(',')
+                repeat_snaps = check_duplicates_in_list(input_snaps_list)
+                if len(repeat_snaps) > 0:
+                    snapctl_error(
+                        message="Duplicate snaps found in input: " +
+                        f"{', '.join(repeat_snaps)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                remote_snaps_ids = [snap['id'] for snap in self.remote_snaps]
+                for input_snap in input_snaps_list:
+                    if not input_snap in remote_snaps_ids:
+                        snapctl_error(
+                            message="Invalid Snap " + input_snap +
+                            " provided with --snaps. Please check and try again.",
+                            code=SNAPCTL_INPUT_ERROR)
+            if self.features:
+                input_features_list = self.features.split(',')
+                repeat_features = check_duplicates_in_list(input_features_list)
+                if len(repeat_features) > 0:
+                    snapctl_error(
+                        message="Duplicate features found in input: " +
+                        f"{', '.join(repeat_features)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                for feature in input_features_list:
+                    feature = feature.strip()
+                    if feature.upper() not in SnapendManifest.FEATURES:
+                        snapctl_error(
+                            message="--features must be one of " +
+                            f"{', '.join(SnapendManifest.FEATURES)}.",
+                            code=SNAPCTL_INPUT_ERROR)
             if not self.out_path_filename:
                 snapctl_error(
-                    message="Output path is required for update command.",
+                    message="Output path is required for sync command.",
                     code=SNAPCTL_INPUT_ERROR)
             if self.out_path_filename and not (self.out_path_filename.endswith('.json') or
                                                self.out_path_filename.endswith('.yaml') or
@@ -192,10 +253,132 @@ class SnapendManifest:
                     "Please check the file and try again.",
                     code=SNAPCTL_INPUT_ERROR)
         elif self.subcommand == 'upgrade':
+            if not self.manifest_path_filename:
+                snapctl_error(
+                    message="Manifest path is required for upgrade command.",
+                    code=SNAPCTL_INPUT_ERROR)
+            if self.snaps and self.snaps != '':
+                input_snaps_list = self.snaps.split(',')
+                repeat_snaps = check_duplicates_in_list(input_snaps_list)
+                if len(repeat_snaps) > 0:
+                    snapctl_error(
+                        message="Duplicate snaps found in input: " +
+                        f"{', '.join(repeat_snaps)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+            if not self.out_path_filename:
+                snapctl_error(
+                    message="Output path is required for upgrade command.",
+                    code=SNAPCTL_INPUT_ERROR)
+            if self.out_path_filename and not (self.out_path_filename.endswith('.json') or
+                                               self.out_path_filename.endswith('.yaml') or
+                                               self.out_path_filename.endswith('.yml')):
+                snapctl_error(
+                    message="Output path must end with .json, .yaml or .yml",
+                    code=SNAPCTL_INPUT_ERROR)
+            if not self.manifest:
+                snapctl_error(
+                    message="Unable to read the manifest file. " +
+                    "Please check the file and try again.",
+                    code=SNAPCTL_INPUT_ERROR)
+            if 'service_definitions' not in self.manifest:
+                snapctl_error(
+                    message="Invalid manifest file. Need service_definitions. " +
+                    "Please check the file and try again.",
+                    code=SNAPCTL_INPUT_ERROR)
+            if self.snaps and self.snaps != '':
+                input_snaps_list = self.snaps.split(',')
+                remote_snaps_ids = [snap['id'] for snap in self.remote_snaps]
+                current_snap_ids = [snap['id']
+                                    for snap in self.manifest['service_definitions']]
+                for input_snap in input_snaps_list:
+                    if not input_snap in remote_snaps_ids:
+                        snapctl_error(
+                            message="Invalid Snap " + input_snap +
+                            " provided with --snaps. Please check and try again.",
+                            code=SNAPCTL_INPUT_ERROR)
+                    if not input_snap in current_snap_ids:
+                        snapctl_error(
+                            message="Snap " + input_snap +
+                            " provided with --snaps is not present in the manifest. " +
+                            "Please check and try again.",
+                            code=SNAPCTL_INPUT_ERROR)
+        elif self.subcommand == 'update':
             if not self.manifest_path_filename:
                 snapctl_error(
                     message="Manifest path is required for update command.",
                     code=SNAPCTL_INPUT_ERROR)
+            if (not self.add_snaps or self.add_snaps == '') and \
+                (not self.remove_snaps or self.remove_snaps == '') and \
+                (not self.add_features or self.add_features == '') and \
+                    (not self.remove_features or self.remove_features == ''):
+                snapctl_error(
+                    message="At least one of --add-snaps, --remove-snaps, add-features " +
+                    "or --remove-features is required to update a snapend manifest.",
+                    code=SNAPCTL_INPUT_ERROR)
+            if self.add_snaps and self.add_snaps != '':
+                input_snaps_list = self.add_snaps.split(',')
+                repeat_snaps = check_duplicates_in_list(input_snaps_list)
+                if len(repeat_snaps) > 0:
+                    snapctl_error(
+                        message="Duplicate snaps found in input: " +
+                        f"{', '.join(repeat_snaps)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                remote_snaps_ids = [snap['id'] for snap in self.remote_snaps]
+                for input_snap in input_snaps_list:
+                    if not input_snap in remote_snaps_ids:
+                        snapctl_error(
+                            message="Invalid Snap " + input_snap +
+                            " provided with --add-snaps. Please check and try again.",
+                            code=SNAPCTL_INPUT_ERROR)
+            if self.remove_snaps and self.remove_snaps != '':
+                input_snaps_list = self.remove_snaps.split(',')
+                if SnapendManifest.AUTH_SNAP_ID in input_snaps_list:
+                    snapctl_error(
+                        message="Auth snap cannot be removed from the manifest.",
+                        code=SNAPCTL_INPUT_ERROR)
+                repeat_snaps = check_duplicates_in_list(input_snaps_list)
+                if len(repeat_snaps) > 0:
+                    snapctl_error(
+                        message="Duplicate snaps found in input: " +
+                        f"{', '.join(repeat_snaps)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                remote_snaps_ids = [snap['id'] for snap in self.remote_snaps]
+                for input_snap in input_snaps_list:
+                    if not input_snap in remote_snaps_ids:
+                        snapctl_error(
+                            message="Invalid Snap " + input_snap +
+                            " provided with --remove-snaps. Please check and try again.",
+                            code=SNAPCTL_INPUT_ERROR)
+            if self.add_features:
+                input_features_list = self.add_features.split(',')
+                repeat_features = check_duplicates_in_list(input_features_list)
+                if len(repeat_features) > 0:
+                    snapctl_error(
+                        message="Duplicate features found in input: " +
+                        f"{', '.join(repeat_features)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                for feature in input_features_list:
+                    feature = feature.strip()
+                    if feature.upper() not in SnapendManifest.FEATURES:
+                        snapctl_error(
+                            message="--add-features must be one of " +
+                            f"{', '.join(SnapendManifest.FEATURES)}.",
+                            code=SNAPCTL_INPUT_ERROR)
+            if self.remove_features:
+                input_features_list = self.remove_features.split(',')
+                repeat_features = check_duplicates_in_list(input_features_list)
+                if len(repeat_features) > 0:
+                    snapctl_error(
+                        message="Duplicate features found in input: " +
+                        f"{', '.join(repeat_features)}. Please check and try again.",
+                        code=SNAPCTL_INPUT_ERROR)
+                for feature in input_features_list:
+                    feature = feature.strip()
+                    if feature.upper() not in SnapendManifest.FEATURES:
+                        snapctl_error(
+                            message="--remove-features must be one of " +
+                            f"{', '.join(SnapendManifest.FEATURES)}.",
+                            code=SNAPCTL_INPUT_ERROR)
             if not self.out_path_filename:
                 snapctl_error(
                     message="Output path is required for update command.",
@@ -250,7 +433,7 @@ class SnapendManifest:
         """
           Create a snapend manifest
           @test -
-          `python -m snapctl snapend-manifest create --name my-dev-snapend --env DEVELOPMENT --snaps auth,analytics --out-path-filename ./snapend-manifest.json`
+          `python -m snapctl snapend-manifest create --name my-dev-snapend --env DEVELOPMENT --snaps auth,analytics --out-path-filename ./snapend-create-manifest.json`
         """
         progress = Progress(
             SpinnerColumn(),
@@ -270,21 +453,14 @@ class SnapendManifest:
                 "external_endpoints": [],
                 "settings": []
             }
-            snap_ids = [snap_id.strip()
-                        for snap_id in self.snaps.split(',')]
-            for snap_id in snap_ids:
-                snap_found = False
-                for snap in self.remote_snaps:
-                    if snap['id'] == snap_id:
-                        snap_sd = self._get_snap_sd(snap_id)
-                        new_manifest['service_definitions'].append(snap_sd)
-                        snap_found = True
-                        break
-                if not snap_found:
-                    snapctl_error(
-                        message=f"Snap ID {snap_id} not found in your snaps.",
-                        code=SNAPCTL_INPUT_ERROR,
-                        progress=progress)
+            if self.snaps and self.snaps != '':
+                snap_ids = [snap_id.strip()
+                            for snap_id in self.snaps.split(',')]
+                for snap_id in snap_ids:
+                    snap_sd = self._get_snap_sd(snap_id)
+                    new_manifest['service_definitions'].append(snap_sd)
+                    info(f"Added snap {snap_id} to the manifest.")
+            # If auth snap is not present, add it
             found_auth = False
             for final_snap in new_manifest['service_definitions']:
                 if final_snap['id'] == SnapendManifest.AUTH_SNAP_ID:
@@ -303,6 +479,7 @@ class SnapendManifest:
                     if feature.upper() not in new_manifest['feature_definitions']:
                         new_manifest['feature_definitions'].append(
                             feature.upper())
+                        info(f"Added feature {feature} to the manifest.")
             if self.out_path_filename:
                 # Based on the out-path extension, write JSON or YAML
                 if self.out_path_filename.endswith('.yaml') or self.out_path_filename.endswith('.yml'):
@@ -343,11 +520,11 @@ class SnapendManifest:
             message='Failed to create snapend manifest.',
             code=SNAPCTL_SNAPEND_MANIFEST_CREATE_ERROR, progress=progress)
 
-    def update(self) -> bool:
+    def sync(self) -> bool:
         """
-          Update a snapend manifest
+          Sync with a snapend manifest
           @test -
-          `python -m snapctl snapend-manifest update --manifest-path-filename ./snapend-manifest.json --features WEB_SOCKETS  --out-path-filename ./snapend-updated-manifest.json`
+          `python -m snapctl snapend-manifest sync --manifest-path-filename ./snapend-manifest.json --snaps analytics,auth --features WEB_SOCKETS  --out-path-filename ./snapend-updated-manifest.json`
         """
         progress = Progress(
             SpinnerColumn(),
@@ -356,41 +533,33 @@ class SnapendManifest:
         )
         progress.start()
         progress.add_task(
-            description='Updating snapend manifest...', total=None)
+            description='Syncing snapend manifest...', total=None)
         try:
             if 'applied_configuration' in self.manifest:
                 info('Applied configuration found in the manifest. ')
                 warning(
                     'You need to ensure you have synced the manifest from remote. ' +
                     'Else if you try applying the newly generated manifest it may not work.')
-
             current_snaps = self.manifest['service_definitions']
             current_snap_ids = [snap['id'] for snap in current_snaps]
             final_snaps = []
             if self.snaps and self.snaps != '':
-                for snap_id in self.snaps.split(','):
+                input_snap_list = self.snaps.split(',')
+                for snap_id in input_snap_list:
                     snap_id = snap_id.strip()
                     if snap_id == '':
                         continue
+                    # Copy existing snap if already present
                     if snap_id in current_snap_ids:
                         warning(
                             f"Snap {snap_id} already exists in the manifest. Skipping...")
                         final_snaps.append(
                             current_snaps[current_snap_ids.index(snap_id)])
                         continue
-                    snap_found = False
-                    for snap in self.remote_snaps:
-                        if snap['id'] == snap_id:
-                            snap_found = True
-                            snap_sd = self._get_snap_sd(snap_id)
-                            final_snaps.append(snap_sd)
-                            info(f"Added snap {snap_id} to the manifest.")
-                            break
-                    if not snap_found:
-                        snapctl_error(
-                            message=f"Snap ID {snap_id} not found in your snaps.",
-                            code=SNAPCTL_INPUT_ERROR,
-                            progress=progress)
+                    # Else add new snap from remote snaps
+                    snap_sd = self._get_snap_sd(snap_id)
+                    final_snaps.append(snap_sd)
+                    info(f"Added snap {snap_id} to the manifest.")
             found_auth = False
             for final_snap in final_snaps:
                 if final_snap['id'] == SnapendManifest.AUTH_SNAP_ID:
@@ -404,19 +573,23 @@ class SnapendManifest:
             warning(
                 f'Old snaps list "{",".join(current_snap_ids)}" will be ' +
                 f'replaced with new snaps list "{",".join([snap['id'] for snap in final_snaps])}"')
+            final_snaps.sort(key=lambda x: x["id"])
             self.manifest['service_definitions'] = final_snaps
 
             final_features = []
             if self.features and self.features != '':
                 current_features = self.manifest['feature_definitions']
-                for feature in self.features.split(','):
+                input_feature_list = self.features.split(',')
+                for feature in input_feature_list:
                     feature = feature.strip()
                     if feature == '':
                         continue
+                    final_features.append(feature.upper())
                     if feature.upper() in current_features:
                         warning(
                             f"Feature {feature} already exists in the manifest. Skipping...")
-                    final_features.append(feature.upper())
+                    else:
+                        info(f"Added feature {feature} to the manifest.")
             warning(
                 f'Old features list: "{",".join(self.manifest["feature_definitions"])}" will ' +
                 f'be replaced with new features list: "{",".join([feature for feature in final_features])}"')
@@ -441,7 +614,7 @@ class SnapendManifest:
                     out_file.write(json.dumps(self.manifest, indent=4))
             info(f"Output written to {self.out_path_filename}")
             snapctl_success(
-                message="Snapend manifest updated successfully.",
+                message="Snapend manifest synced successfully.",
                 progress=progress)
         except ValueError as e:
             snapctl_error(
@@ -449,13 +622,13 @@ class SnapendManifest:
                 code=SNAPCTL_INTERNAL_SERVER_ERROR, progress=progress)
         except RequestException as e:
             snapctl_error(
-                message=f"Exception: Unable to update snapend manifest {e}",
-                code=SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR, progress=progress)
+                message=f"Exception: Unable to synced snapend manifest {e}",
+                code=SNAPCTL_SNAPEND_MANIFEST_SYNC_ERROR, progress=progress)
         finally:
             progress.stop()
         snapctl_error(
-            message='Failed to update the snapend manifest.',
-            code=SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR, progress=progress)
+            message='Failed to synced the snapend manifest.',
+            code=SNAPCTL_SNAPEND_MANIFEST_SYNC_ERROR, progress=progress)
 
     def upgrade(self) -> bool:
         """
@@ -504,6 +677,7 @@ class SnapendManifest:
                                 f"Snap {snap['id']} is already at the latest " +
                                 f"version {snap['version']}. Skipping...")
                         break
+            current_snaps.sort(key=lambda x: x["id"])
             self.manifest['service_definitions'] = current_snaps
 
             # Write output
@@ -539,3 +713,149 @@ class SnapendManifest:
         snapctl_error(
             message='Failed to upgrade the snapend manifest.',
             code=SNAPCTL_SNAPEND_MANIFEST_UPGRADE_ERROR, progress=progress)
+
+    def update(self) -> bool:
+        """
+          Update a snapend manifest
+          @test -
+          `python -m snapctl snapend-manifest update --manifest-path-filename ./snapend-manifest.json --add-snaps analytics,auth --add-features WEB_SOCKETS --out-path-filename ./snapend-updated-manifest.json`
+        """
+        progress = Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        )
+        progress.start()
+        progress.add_task(
+            description='Updating snapend manifest...', total=None)
+        try:
+            if 'applied_configuration' in self.manifest:
+                info('Applied configuration found in the manifest. ')
+                warning(
+                    'You need to ensure you have synced the manifest from remote. ' +
+                    'Else if you try applying the newly generated manifest it may not work.')
+            current_snaps = self.manifest['service_definitions']
+            current_snap_ids = [snap['id'] for snap in current_snaps]
+            final_added_snap_ids = []
+            final_removed_snap_ids = []
+            if self.add_snaps and self.add_snaps != '':
+                add_snap_list = self.add_snaps.split(',')
+                for snap_id in add_snap_list:
+                    snap_id = snap_id.strip()
+                    if snap_id == '':
+                        continue
+                    # Copy existing snap if already present
+                    if snap_id in current_snap_ids:
+                        warning(
+                            f"Snap {snap_id} already exists in the manifest. Skipping...")
+                        continue
+                    # Else add new snap from remote snaps
+                    snap_sd = self._get_snap_sd(snap_id)
+                    current_snaps.append(snap_sd)
+                    current_snap_ids.append(snap_id)
+                    final_added_snap_ids.append(snap_id)
+                    info(f"Added snap {snap_id} to the manifest.")
+            if self.remove_snaps and self.remove_snaps != '':
+                remove_snap_list = self.remove_snaps.split(',')
+                for snap_id in remove_snap_list:
+                    snap_id = snap_id.strip()
+                    if snap_id == '':
+                        continue
+                    if snap_id not in current_snap_ids:
+                        warning(
+                            f"Snap {snap_id} does not exist in the manifest. Skipping...")
+                        continue
+                    # Remove snap from current snaps
+                    index = current_snap_ids.index(snap_id)
+                    current_snaps.pop(index)
+                    current_snap_ids.pop(index)
+                    final_removed_snap_ids.append(snap_id)
+                    info(f"Removed snap {snap_id} from the manifest.")
+
+            found_auth = False
+            for final_snap in current_snap_ids:
+                if final_snap == SnapendManifest.AUTH_SNAP_ID:
+                    found_auth = True
+                    break
+            if not found_auth:
+                auth_sd = self._get_snap_sd(SnapendManifest.AUTH_SNAP_ID)
+                current_snaps.append(auth_sd)
+                current_snap_ids.append(SnapendManifest.AUTH_SNAP_ID)
+                final_added_snap_ids.append(SnapendManifest.AUTH_SNAP_ID)
+                warning(
+                    'Auth snap is required for snapend. Added auth snap to the manifest.')
+            warning(
+                f'New snaps "{",".join(final_added_snap_ids)}" were added. ' +
+                f'Snaps "{",".join(final_removed_snap_ids)}" were removed. ')
+            current_snaps.sort(key=lambda x: x["id"])
+            self.manifest['service_definitions'] = current_snaps
+
+            current_features = self.manifest['feature_definitions']
+            final_added_features = []
+            final_removed_features = []
+            if self.add_features and self.add_features != '':
+                add_feature_list = self.add_features.split(',')
+                for feature in add_feature_list:
+                    feature = feature.strip()
+                    if feature == '':
+                        continue
+                    if feature.upper() in current_features:
+                        warning(
+                            f"Feature {feature} already exists in the manifest. Skipping...")
+                        continue
+                    current_features.append(feature.upper())
+                    final_added_features.append(feature.upper())
+                    info(f"Added feature {feature} to the manifest.")
+            if self.remove_features and self.remove_features != '':
+                remove_feature_list = self.remove_features.split(',')
+                for feature in remove_feature_list:
+                    feature = feature.strip()
+                    if feature == '':
+                        continue
+                    if feature.upper() not in current_features:
+                        warning(
+                            f"Feature {feature} does not exist in the manifest. Skipping...")
+                        continue
+                    index = current_features.index(feature.upper())
+                    current_features.pop(index)
+                    final_removed_features.append(feature.upper())
+                    info(f"Removed feature {feature} from the manifest.")
+            warning(
+                f'New features "{",".join(final_added_features)}" were added. ' +
+                f'Features "{",".join(final_removed_features)}" were removed. ')
+            current_features.sort()
+            self.manifest['feature_definitions'] = current_features
+
+            # Write output
+            # Based on the out-path extension, write JSON or YAML
+            if self.out_path_filename.endswith('.yaml') or self.out_path_filename.endswith('.yml'):
+                try:
+                    import yaml  # type: ignore
+                except ImportError as e:
+                    snapctl_error(
+                        message="YAML output requested but PyYAML is not installed. "
+                        "Install with: pip install pyyaml",
+                        code=SNAPCTL_INPUT_ERROR,
+                        progress=progress)
+                with open(self.out_path_filename, 'w') as out_file:
+                    yaml.dump(self.manifest, out_file, sort_keys=False)
+            else:
+                with open(self.out_path_filename, 'w') as out_file:
+                    out_file.write(json.dumps(self.manifest, indent=4))
+            info(f"Output written to {self.out_path_filename}")
+            snapctl_success(
+                message="Snapend manifest updated successfully.",
+                progress=progress)
+        except ValueError as e:
+            snapctl_error(
+                message=f"Exception: {e}",
+                code=SNAPCTL_INTERNAL_SERVER_ERROR, progress=progress)
+        except RequestException as e:
+            snapctl_error(
+                message=f"Exception: Unable to update snapend manifest {e}",
+                code=SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR, progress=progress)
+        finally:
+            progress.stop()
+        snapctl_error(
+            message='Failed to update the snapend manifest.',
+            code=SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR, progress=progress)

snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = ''
-VERSION = '1.1.0'
+VERSION = '1.1.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -53,8 +53,9 @@ SNAPCTL_SNAPS_ENUMERATE_ERROR = 14
 
 # Snapend Manifest Errors - 16 - 19
 SNAPCTL_SNAPEND_MANIFEST_CREATE_ERROR = 16
-SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR = 17
+SNAPCTL_SNAPEND_MANIFEST_SYNC_ERROR = 17
 SNAPCTL_SNAPEND_MANIFEST_UPGRADE_ERROR = 18
+SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR = 19
 
 # BYOGS Errors - 20 - 29
 SNAPCTL_BYOGS_GENERIC_ERROR = 20

snapctl/data/releases/1.1.1.mdx

@@ -0,0 +1,8 @@
+## Release 1.1.1
+##### Oct 15, 2025
+
+### Features
+1. Snapend manifest command now supports `sync` and `update` subcommands.
+
+### Bug Fixes
+1. The update command was always upgrading the auth snap to the latest version. This has now been fixed.

snapctl/main.py

@@ -861,20 +861,40 @@ def snapend_manifest(
     ),
     manifest_path_filename: Union[str, None] = typer.Option(
         None, "--manifest-path-filename", help=(
-            "(req: update, upgrade) Full Path to the manifest file including the filename."
+            "(req: sync, upgrade) Full Path to the manifest file including the filename."
         )
     ),
     snaps_list_str: str = typer.Option(
         None, "--snaps", help=(
-            "(use: create, update, upgrade) Comma separated list of snap ids to add, update or upgrade. "
+            "(use: create, sync, upgrade) Comma separated list of snap ids to add, sync or upgrade. "
         )
     ),
     features: str = typer.Option(
         None, "--features", help=(
-            "(use: create, update) Comma separated list of feature flags to add, update. "
+            "(use: create, sync) Comma separated list of feature flags to add, sync. "
             "Features: " + ", ".join(SnapendManifest.FEATURES)
         )
     ),
+    add_snaps: str = typer.Option(
+        None, "--add-snaps", help=(
+            "(use: update) Comma separated list of snap ids to add. "
+        )
+    ),
+    remove_snaps: str = typer.Option(
+        None, "--remove-snaps", help=(
+            "(use: update) Comma separated list of snap ids to remove. "
+        )
+    ),
+    add_features: str = typer.Option(
+        None, "--add-features", help=(
+            "(use: update) Comma separated list of features to add. "
+        )
+    ),
+    remove_features: str = typer.Option(
+        None, "--remove-features", help=(
+            "(use: update) Comma separated list of features to remove. "
+        )
+    ),
     out_path_filename: Union[str, None] = typer.Option(
         None, "--out-path-filename", help=(
             "(optional: enumerate) Path and filename to output the manifest. The filename should end with .json or .yaml"
@@ -901,6 +921,10 @@ def snapend_manifest(
         manifest_path_filename=manifest_path_filename,
         snaps=snaps_list_str,
         features=features,
+        add_snaps=add_snaps,
+        remove_snaps=remove_snaps,
+        add_features=add_features,
+        remove_features=remove_features,
         out_path_filename=out_path_filename,
     )
     getattr(snapend_manifest_obj, subcommand.replace('-', '_'))()

snapctl/utils/helper.py

@@ -3,6 +3,7 @@ Helper functions for snapctl
 """
 from typing import Union, Dict
 from pathlib import Path
+from collections import Counter
 import re
 import platform
 import os
@@ -204,3 +205,10 @@ def get_config_value(environment: str, key: str) -> str:
     if environment == '' or environment not in APP_CONFIG or key not in APP_CONFIG[environment]:
         return ''
     return APP_CONFIG[environment][key]
+
+
+def check_duplicates_in_list(items: list[str]) -> list[str]:
+    '''
+    Check for duplicates in a list and return the duplicate items
+    '''
+    return [k for k, v in Counter(items).items() if v > 1]

{snapctl-1.1.0.dist-info → snapctl-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 1.1.0
+Version: 1.1.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -641,7 +641,9 @@ snapctl snapend-manifest --help
 
 #### 2. Snapend Manifest Create
 
-Create a Snapend manifest. The output manifest file can then be used with the `snapend create` or `snapend clone` commands.
+Create a Snapend manifest. It should be noted that the latest versions of the snap at the time of running the command is what gets added to the manifest. For example, say the `analytics` snap has versions `v1.0.0`, `v1.1.0` available on the web portal. If you run the create command with `--snaps analytics` the `v1.1.0` which is the latest at that moment in time, gets added to your manifest.
+
+The output manifest file can then be used with the `snapend create` or `snapend clone` commands.
 
 ```bash
 # Create a Snapend manifest file
@@ -654,15 +656,21 @@ Create a Snapend manifest. The output manifest file can then be used with the `s
 # Note: One of snaps or features is required
 # Example:
 #   snapend-manifest create --name my-dev-snapend --env DEVELOPMENT --snaps auth,analytics --add-features WEB_SOCKETS --out-path ./snapend-manifest.json
-snapctl snapend-manifest create --name $name$ --env $env$ --snaps $snaps --features $features --out-path-filename $output_path_filename
+
+snapctl snapend-manifest create --name $name --env $env --snaps $snaps --features $features --out-path-filename $output_path_filename
 ```
 
-#### 3. Snapend Manifest Update
+#### 3. Snapend Manifest Sync
+
+Sync with an existing Snapend manifest. This command is idempotent and destructive.
 
-Update an existing Snapend manifest.
+- It ensures the input manifest gets replaced with the values you pass in `--snaps` and `--features`. For example: If your input manifest has a snap but you do not pass the snap in the `--snaps`, it will be removed from the output. Same goes for `--features`.
+- Additionally, if a snap is present in the manifest and you pass it in as part of `--snaps` it will not be touched. But if a snap is not part of the manifest and you pass it in as part of `--snaps` it will be added with the latest version of the snap. For example, say the `analytics` snap has versions `v1.0.0`, `v1.1.0` available on the web portal. If you run the sync command with `--snaps analytics` and you had `v1.0.0` in the manifest then it wont be touched. However, if you did not have it in the manifest then the `v1.1.0` which is the latest at that moment in time, gets added to your manifest.
+
+**IMPORTANT**: If you are looking for a command to purely add or remove snaps or features, consider using the `update` command instead.
 
 ```bash
-# Update a Snapend manifest file
+# Sync a Snapend manifest file
 # $input_manifest = Path and file name of the current manifest. The filename should end with .json or .yaml
 # $output_path_filename = Path and file name to store the manifest. The filename should end with .json or .yaml
 # $snaps = Comma separated list of snap ids you want to have at the end. You can get the snap ids from # the `snapctl snaps enumerate --out-path ./snaps.json` command.
@@ -671,14 +679,14 @@ Update an existing Snapend manifest.
 #   IMPORTANT: If your manifest has a feature but your --features does not. It will be removed.
 # Note: One of snaps, and features is required
 # Example:
-#   snapctl snapend-manifest update --manifest-path-filename ./snapser-jn86b0dv-manifest.yaml --add-snaps game-server-fleets --remove-snaps analytics --remove-features WEB_SOCKETS --out-path ./snapend-updated-manifest.yaml
+#   snapctl snapend-manifest sync --manifest-path-filename ./snapser-jn86b0dv-manifest.yaml --add-snaps game-server-fleets --remove-snaps analytics --remove-features WEB_SOCKETS --out-path ./snapend-updated-manifest.yaml
 
 snapctl snapend-manifest update --manifest-path-filename $input_manifest --snaps $snaps --features $features--out-path-filename $output_path_filename
 ```
 
 #### 4. Snapend Manifest Upgrade
 
-Upgrade all snaps or a list of snaps to the latest version
+Upgrade all snaps or a list of snaps to the latest version of the snap available at that moment in time. If you do not pass in `--snaps` then all the snaps in the manifest will be upgraded. If you do pass a list of snaps then all snap Ids are expected to be valid.
 
 ```bash
 # Update a Snapend manifest file
@@ -691,9 +699,35 @@ Upgrade all snaps or a list of snaps to the latest version
 # snapctl snapend-manifest upgrade --manifest-path-filename ./snapser-jn86b0dv-manifest.yaml --snaps game-server-fleets --out-path ./snapend-updated-manifest.yaml
 # snapctl snapend-manifest upgrade --manifest-path-filename ./snapser-jn86b0dv-manifest.yaml --out-path ./snapend-updated-manifest.yaml
 
+snapctl snapend-manifest upgrade --manifest-path-filename $input_manifest --out-path-filename $output_path_filename
+
 snapctl snapend-manifest upgrade --manifest-path-filename $input_manifest --snaps $snaps --out-path-filename $output_path_filename
 ```
 
+#### 5. Snapend Manifest Update
+
+Update your manifest. This command is additive and subtractive. It allows you to add or remove, snaps and features from an existing manifest. Unlike `sync`, this will only add or remove entities from your manifest, keeping the remaining part of the manifest intact. If your manifest has a snap and you pass it with `--add-snaps` then it will be ignored. However if you do not have a snap and you pass it with `--add-snaps` then the latest version of the snap will be added. If you pass a snap with `--remove-snaps` that is already not in the manifest, then it will be skipped. This ensures idempotency after the initial update is made to the snapend manifest.
+
+**IMPORTANT**:
+- All additions are performed before removals.
+- If you are looking to have strict relation between your input (snaps + features) and your output manifest, consider using the `sync` command.
+
+```bash
+# Update a Snapend manifest file
+# $input_manifest = Path and file name of the current manifest. The filename should end with .json or .yaml
+# $output_path_filename = Path and file name to store the manifest. The filename should end with .json or .yaml
+# $addSnaps = Comma separated list of snap ids you want to add to your manifest. You can get the snap ids from # the `snapctl snaps enumerate --out-path ./snaps.json` command.
+# $removeSnaps = Comma separated list of snap ids you want to remove from your manifest. You can get the snap ids from # the `snapctl snaps enumerate --out-path ./snaps.json` command.
+# $addFeatures = Pass `WEB_SOCKETS` if you want to enable web sockets for your backend.
+# $removeFeatures = Pass `WEB_SOCKETS` if you want to disable web sockets for your backend.
+# Note: One of add-snaps, remove-snaps, add-features or remove-features is required
+# Example:
+#   snapctl snapend-manifest update --manifest-path-filename ./snapser-jn86b0dv-manifest.yaml --add-snaps game-server-fleets --remove-snaps analytics --remove-features WEB_SOCKETS --out-path ./snapend-updated-manifest.yaml
+
+snapctl snapend-manifest update --manifest-path-filename $input_manifest --add-snaps $addSnaps --remove-snaps $removeSnaps --add-features $addFeatures --remove-features $removeFeatures --out-path-filename $output_path_filename
+```
+
+
 ### 7. Snapend
 Snapctl commands for your snapend
 

{snapctl-1.1.0.dist-info → snapctl-1.1.1.dist-info}/RECORD

@@ -9,11 +9,11 @@ snapctl/commands/game.py,sha256=F6TL5T3i8yZAQxfsx0uma2tbLHCQ_gqA1wj6oxkAgGk,5236
 snapctl/commands/generate.py,sha256=9-NlZVQllBT2LZT_t9S3ztwtHzTbM-C8_x0f6z70U3g,5606
 snapctl/commands/release_notes.py,sha256=EMl-NK9-MSdRxiVyA0MLX4CBG0zijOctddEODQa5PZ4,2151
 snapctl/commands/snapend.py,sha256=DuzqpVRiQzTI1LAJICDRAjoFNKhyhbMkfaBsmsjuxO4,50307
-snapctl/commands/snapend_manifest.py,sha256=Ox9MSt0TAxtZmTRUC9zm7-nk6jHNFXi41aqbwP7dJw8,25296
+snapctl/commands/snapend_manifest.py,sha256=F4Ql-jkfPvkTrrQ5RfTXp8Jk5s4EFSkWtoOvzxdcacQ,43255
 snapctl/commands/snaps.py,sha256=VI7B1FtrYAyJTxtQcOU6BgImwRND0ZXJGTWSpCXKzW0,4103
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/config/app.py,sha256=U9Mm0BbGJoqcmBBam2tN7F-oTf_u9dK6EJsiB-yVvKg,888
-snapctl/config/constants.py,sha256=VbOYl6_GjXIlBqv1mVVqwOv6r7GFLXhcUhWy1Z56YXY,4332
+snapctl/config/constants.py,sha256=S0YABPFZfRF_NTrpZpfs6bnybhJrPPzLkXYkriJYJt8,4373
 snapctl/config/endpoints.py,sha256=jD0n5ocJBbIkrb97F2_r9hqAHzUuddAqzqqBAPUKDTI,477
 snapctl/config/hashes.py,sha256=3OKAyOxQPnn--_hvPIzFJnhC8NVfQK4WT-RH4PHEV1w,5242
 snapctl/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -26,6 +26,7 @@ snapctl/data/releases/1.0.2.mdx,sha256=BptVj9boWRf_V22O0V4EzkGFPFWK6XzRQUQlmTFTZ
 snapctl/data/releases/1.0.3.mdx,sha256=Ifm6kRQQghCWx_OJ3shNOxozUP3hH_yt8dMap7B-1tw,149
 snapctl/data/releases/1.0.4.mdx,sha256=hKwi0tormf0gvKAY5W4G1BY7L6fgwOzlw3R-WGSH49g,243
 snapctl/data/releases/1.1.0.mdx,sha256=w_X9SsMH-ghex8UYQn9b1AcQT9i3eeAlQWP2YCVU_kY,1303
+snapctl/data/releases/1.1.1.mdx,sha256=J9PMNlO9EtbIH29Elfd8vsj9xwm-hYX8njFrlJy2Su0,244
 snapctl/data/releases/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/data/releases/beta-0.46.0.mdx,sha256=_MJA7TnnJjAnNm_EOvoBiz7FjHwl4c49sYtZ9r4KZQE,2386
 snapctl/data/releases/beta-0.46.4.mdx,sha256=3-ojdCyvax27sdd8nKmcP0zfCWEzi_edPbSlkFqla4o,173
@@ -40,16 +41,16 @@ snapctl/data/releases/beta-0.49.3.mdx,sha256=XmSfpiH-LqvKS2REJ5FGDcLgyEN-OcSzwrX
 snapctl/data/releases/beta-0.50.0.mdx,sha256=_w9f1HjHqukQ8IaTfUdk2W3gBcSwjMyMA8-rjuUxYTo,399
 snapctl/data/releases/beta-0.51.0.mdx,sha256=5_xY29NJtH3Qa92UycCudrwDkSlUHRVNnP4GE4hF7-Y,93
 snapctl/data/releases/beta-0.53.1.mdx,sha256=b__2LPkDhU3cTw5UC19Hxv1rDz6BsSLeI6fhHjOCP08,149
-snapctl/main.py,sha256=UNi8kWctsyVR7cpCNxw-n6l6IDNE4pw3M-Wq-3sd920,31686
+snapctl/main.py,sha256=ZTHmYAW_np3ojTGO7l6eBu2Anbm84uWt9ry0HGQ8K4M,32478
 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=9fxrPW9kNJwiJvJBFy9RlAP4qGRcPTOHfQb3pQh3CMg,1446
 snapctl/utils/exceptions.py,sha256=deLs6sOKIUrhjKNgiMpNC1S6lkU0rpZ7Ml4Tx1CN_Ss,155
-snapctl/utils/helper.py,sha256=TUgpWShLC3Fs9SdkhPUZdMF2kQ-0CI0eUEFv87h2U-Q,7188
+snapctl/utils/helper.py,sha256=8PwlN8xcx4ivHhEudt-PwAl1IL4h1vR0ah7qPEdzWhU,7424
 snapctl/utils/telemetry.py,sha256=_VntKXUrKgJoLKCskH0Z5VhthiVo8CP572U0mcZIH4k,5028
-snapctl-1.1.0.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-1.1.0.dist-info/METADATA,sha256=Yx7OIPotmIJ6XLOKKBYEueGQegXArHYecicPryl__OA,42279
-snapctl-1.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-1.1.0.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-1.1.0.dist-info/RECORD,,
+snapctl-1.1.1.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-1.1.1.dist-info/METADATA,sha256=9OSkp-ad-_KGShm8yjy71SoYy4h0WXScxiAocnvUGag,46268
+snapctl-1.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-1.1.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-1.1.1.dist-info/RECORD,,