refactor: Change the CLI layout for swarm (#191)

Author: xmnlab

.makim.yaml

@@ -347,20 +347,20 @@ groups:
 
           # Test stack commands
           echo $'\033[32mTesting stack deployment...\033[0m'
-          sugar ${{ vars.SUGAR_FLAGS }} swarm deploy --stack test-stack
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:stack deploy --stack test-stack
 
           # List services (with and without stack filter)
           echo $'\033[32mTesting service listing...\033[0m'
           sugar ${{ vars.SUGAR_FLAGS }} swarm ls
-          sugar ${{ vars.SUGAR_FLAGS }} swarm ls --stack test-stack
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:stack ls --stack test-stack
 
           # Test stack ps command
           echo $'\033[32mTesting stack ps command...\033[0m'
-          sugar ${{ vars.SUGAR_FLAGS }} swarm ps --stack test-stack
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:stack ps --stack test-stack
 
           # Test service inspection
           echo $'\033[32mTesting service inspection...\033[0m'
-          sugar ${{ vars.SUGAR_FLAGS }} swarm inspect --service service1-1 --stack test-stack
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:stack inspect --service service1-1 --stack test-stack
 
           # Test service1-1 , service1-2 and service1-3 service three times ping
           for port in 18000 18001 18002; do
@@ -372,13 +372,13 @@ groups:
 
           # Test service logs (limited command to avoid test hanging)
           echo $'\033[32mTesting service logs...\033[0m'
-          sugar ${{ vars.SUGAR_FLAGS }} swarm logs --services service1-1 --stack test-stack --tail 10
-          sugar ${{ vars.SUGAR_FLAGS }} swarm logs --services service1-2 --stack test-stack --tail 10
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:service logs --services service1-1 --stack test-stack --tail 10
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:service logs --services service1-2 --stack test-stack --tail 10
 
 
           # Test service scaling
           echo $'\033[32mTesting service scaling...\033[0m'
-          sugar ${{ vars.SUGAR_FLAGS }} swarm scale --stack test-stack --replicas service1-1=2,service1-2=3
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:service scale --stack test-stack --replicas service1-1=2,service1-2=3
 
           # TODO : sugar swarm update is yet to be implemented and experimental stage
           # Test service update
@@ -387,11 +387,11 @@ groups:
 
           # Test service rollback
           echo $'\033[32mTesting service rollback specific services in a stack...\033[0m'
-          sugar ${{ vars.SUGAR_FLAGS }} swarm rollback --services service1-1,service1-3 --stack test-stack
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:service rollback --services service1-1,service1-3 test-stack
 
           # Test rollback with stack parameter
           echo $'\033[32mTesting stack rollback all services in a stack...\033[0m'
-          sugar ${{ vars.SUGAR_FLAGS }} swarm rollback --stack test-stack --all
+          sugar ${{ vars.SUGAR_FLAGS }} swarm:service rollback test-stack --all
 
           # Test swarm service subcommand
           echo $'\033[32mTesting swarm service commands...\033[0m'
@@ -406,11 +406,11 @@ groups:
 
           # Test node commands
           echo $'\033[32mTesting node commands...\033[0m'
-          sugar swarm node --ls
+          sugar swarm:node ls
           NODE_ID=$(docker node ls --format "{{.ID}}" )
           echo $'\033[32mNode ID: $NODE_ID\033[0m'
-          sugar swarm node --inspect $NODE_ID
-          sugar swarm node --ps $NODE_ID
+          sugar swarm:node inspect $NODE_ID
+          sugar swarm:node ps $NODE_ID
 
 
           # Leave swarm

docs/swarm.md

@@ -70,45 +70,45 @@ $ sugar swarm join --options "--token SWMTKN-1-... 192.168.1.1:2377"
 Deploy a stack from a sugar compose file:
 
 ```bash
-$ sugar swarm deploy --stack my_stack --file ./.sugar-prod.yml
+$ sugar swarm:stack deploy my_stack --file ./.sugar-prod.yml
 ```
 
 or
 
 if `.sugar.yml` file is present in the your current project root directory
 
 ```bash
-$ sugar swarm deploy --stack my_stack
+$ sugar swarm:stack deploy my_stack
 ```
 
 You can also use a `profile2` compose file:
 
 ```bash
-$ sugar swarm deploy --stack my_stack --profile profile2
+$ sugar swarm:stack deploy my_stack --profile profile2
 ```
 
 ### List Services in a Stack
 
 List services in a specific stack:
 
 ```bash
-$ sugar swarm ls --stack my_stack
+$ sugar swarm:stack ls my_stack
 ```
 
 ### List Tasks in a Stack
 
 List the tasks in a stack:
 
 ```bash
-$ sugar swarm ps --stack my_stack
+$ sugar swarm:stack ps my_stack
 ```
 
 ### Remove a Stack
 
 Remove a deployed stack:
 
 ```bash
-$ sugar swarm rm --stack my_stack
+$ sugar swarm:stack rm my_stack
 ```
 
 ## Service Management
@@ -124,37 +124,37 @@ $ sugar swarm ls
 List all services in a specific stack in the swarm
 
 ```bash
-$ sugar swarm ls --stack my_stack
+$ sugar swarm:stack ls my_stack
 ```
 
 ### Inspect Services
 
 Get detailed information about a service:
 
 ```bash
-$ sugar  swarm inspect --service service1-1 --stack my_stack
+$ sugar swarm:service inspect --service service1-1 --stack my_stack
 ```
 
 ### View Service Logs
 
 View logs for a specific service:
 
 ```bash
-$ sugar swarm logs --services service1-1 --stack my_stack
+$ sugar swarm:service logs --services service1-1 --stack my_stack
 ```
 
 With additional options:
 
 ```bash
-$ sugar swarm logs --services myservice --stack my_stack --follow --tail 100
+$ sugar swarm:service logs --services myservice --stack my_stack --follow --tail 100
 ```
 
 ### Scale Services
 
 Scale services within a stack:
 
 ```bash
-$ sugar swarm scale --stack my_stack --replicas service1=3,service2=5
+$ sugar swarm:service scale --stack my_stack --replicas service1=3,service2=5
 ```
 
 ### Update Services (Currently in experemental stage)
@@ -324,47 +324,47 @@ Sugar provides a complete set of commands to manage swarm nodes through the
 ### List Nodes
 
 ```bash
-$ sugar swarm node ls
+$ sugar swarm:node ls
 ```
 
 ### Inspect Nodes
 
 ```bash
-$ sugar swarm node --inspect node-id1,node-id2
+$ sugar swarm:node inspect node-id1,node-id2
 ```
 
 ### Promote Nodes
 
 Promote a worker node to manager:
 
 ```bash
-$ sugar swarm node --promote node-id
+$ sugar swarm:node promote node-id
 ```
 
 ### Demote Nodes
 
 Demote a manager node to worker:
 
 ```bash
-$ sugar swarm node --demote node-id
+$ sugar swarm:node demote node-id
 ```
 
 ### List Tasks on a Node
 
 ```bash
-$ sugar swarm node --ps node-id
+$ sugar swarm:node ps node-id
 ```
 
 ### Remove Nodes
 
 ```bash
-$ sugar swarm node --rm node-id
+$ sugar swarm:node rm node-id
 ```
 
 ### Update Nodes
 
 ```bash
-$ sugar swarm node --update node-id --options "--availability drain"
+$ sugar swarm:node update node-id --options "--availability drain"
 ```
 
 ## Command Options
@@ -394,19 +394,19 @@ Leverage Sugar profiles to manage different Swarm configurations:
 Production Profile:
 
 ```bash
-$ sugar --profile production swarm deploy --stack my_stack
+$ sugar --profile production swarm:stack deploy my_stack
 ```
 
 Development Profile:
 
 ```bash
-$ sugar --profile dev swarm deploy --stack my_stack
+$ sugar --profile dev swarm:stack deploy my_stack
 ```
 
 Testing Profile:
 
 ```bash
-$ sugar --profile test swarm deploy --stack my_stack
+$ sugar --profile test swarm:stack deploy my_stack
 ```
 
 This allows you to maintain different configurations for different environments

src/sugar/core.py

@@ -8,7 +8,12 @@
 from sugar.extensions.compose import SugarCompose
 from sugar.extensions.compose_ext import SugarComposeExt
 from sugar.extensions.podman_ext import SugarPodmanComposeExt
-from sugar.extensions.swarm import SugarSwarm
+from sugar.extensions.swarm import (
+    SugarSwarm,
+    SugarSwarmNode,
+    SugarSwarmService,
+    SugarSwarmStack,
+)
 from sugar.extensions.tui import SugarTUI
 
 try:
@@ -23,6 +28,9 @@
     'compose-ext': SugarComposeExt,
     'podman-ext': SugarPodmanComposeExt,
     'swarm': SugarSwarm,
+    'swarm:stack': SugarSwarmStack,
+    'swarm:service': SugarSwarmService,
+    'swarm:node': SugarSwarmNode,
     'tui': SugarTUI,
     **{'stats': SugarStats for i in range(1) if SugarStats is not None},
 }

src/sugar/extensions/base.py

@@ -119,11 +119,21 @@ def _call_backend_app(
         self,
         action: str,
         services: list[str] = [],
+        nodes: list[str] = [],
         options_args: list[str] = [],
         cmd_args: list[str] = [],
         _out: Union[io.TextIOWrapper, io.StringIO, Any] = sys.stdout,
         _err: Union[io.TextIOWrapper, io.StringIO, Any] = sys.stderr,
     ) -> None:
+        # validation
+        if services and nodes:
+            SugarLogs.raise_error(
+                'Give services or nodes arguments, not both.',
+                SugarError.SUGAR_INVALID_PARAMETER,
+            )
+
+        nodes_or_services = services or nodes
+
         # Execute pre-run hooks
         extension = camel_to_snake(
             self.__class__.__name__.replace('Sugar', '')
@@ -144,7 +154,7 @@ def _call_backend_app(
             *self.backend_args,
             *[action],
             *options_args,
-            *services,
+            *nodes_or_services,
             *cmd_args,
         ]
 

src/sugar/extensions/podman_ext.py

@@ -142,6 +142,7 @@ def _call_backend_app(
         self,
         action: str,
         services: list[str] = [],
+        nodes: list[str] = [],
         options_args: list[str] = [],
         cmd_args: list[str] = [],
         _out: Union[io.TextIOWrapper, io.StringIO, Any] = sys.stdout,
@@ -154,6 +155,13 @@ def _call_backend_app(
         instead of using the --env-file flag that's
         not supported by podman compose.
         """
+        # validation
+        if nodes:
+            SugarLogs.raise_error(
+                'The argument `nodes` is not supported yet '
+                'by the podman plugin.',
+                SugarError.SUGAR_INVALID_PARAMETER,
+            )
         # Execute pre-run hooks
         extension = camel_to_snake(
             self.__class__.__name__.replace('Sugar', '')