snapctl 0.31.1__tar.gz → 0.32.1__tar.gz

snapctl-0.32.1/LICENSE

@@ -0,0 +1,29 @@
+Snapser Inc. Proprietary License
+
+This CLI tool, its source code, and any accompanying documentation (collectively referred to as the "Software") are the property of Snapser Inc. ("Snapser"). The Software is provided under the following license terms and conditions:
+
+1. License Grant:
+   Snapser grants you a non-exclusive, non-transferable, revocable license to use the Software solely for your internal business purposes. You may not distribute, sublicense, rent, lease, sell, or otherwise transfer the Software or any portion thereof.
+
+2. Restrictions:
+   You may not modify, adapt, translate, reverse engineer, decompile, disassemble, or create derivative works based on the Software. You may not remove or alter any copyright, trademark, or other proprietary rights notices contained in the Software.
+
+3. Ownership:
+   The Software and all intellectual property rights therein are and shall remain the exclusive property of Snapser Inc. Nothing in this license agreement shall be construed to transfer ownership of the Software to you.
+
+4. Term and Termination:
+   This license is effective until terminated by either party. Snapser may terminate this license at any time if you breach any of its terms and conditions. Upon termination, you must immediately cease all use of the Software and destroy all copies thereof.
+
+5. Disclaimer of Warranty:
+   THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, SNAPSER DISCLAIMS ALL WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. SNAPSER DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE SOFTWARE WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE.
+
+6. Limitation of Liability:
+   IN NO EVENT SHALL SNAPSER BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION, LOSS OF INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, EVEN IF SNAPSER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Governing Law:
+   This license agreement shall be governed by and construed in accordance with the laws of the United States of America, excluding its conflicts of law principles. Any disputes arising out of or in connection with this agreement shall be subject to the exclusive jurisdiction of the courts located in the United States of America.
+
+By using the Software, you agree to be bound by the terms and conditions of this license agreement. If you do not agree to these terms and conditions, do not use the Software.
+
+Snapser Inc.
+June 4, 2024

{snapctl-0.31.1 → snapctl-0.32.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.31.1
+Version: 0.32.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -11,8 +11,10 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: configparser (>=6.0.0,<7.0.0)
 Requires-Dist: pyfiglet (>=1.0.2,<2.0.0)
+Requires-Dist: pytest (>=8.2.2,<9.0.0)
+Requires-Dist: pytest-mock (>=3.14.0,<4.0.0)
 Requires-Dist: requests (>=2.28.2,<3.0.0)
-Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
+Requires-Dist: typer[all] (>=0.12.3,<0.13.0)
 Description-Content-Type: text/markdown
 
 # Snapser CLI Tool
@@ -244,16 +246,16 @@ snapctl byosnap push $byosnap_sid --tag $image_tag
 Upload swagger.json and README.md for you Snap
 
 ```
-# Help for the byogs command
+# Help for the byosnap command
 snapctl byosnap upload-docs --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
+# $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your swagger.json and README.md files are present
 # Example:
 # snapctl byosnap upload-docs byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap upload-docs $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --path $code_root_path
 ```
 
 #### 6. byosnap publish-image
@@ -305,28 +307,7 @@ See all the supported commands
 snapctl byogs --help
 ```
 
-#### 2. [Deprecated soon] byogs create
-
-Create a custom game server. Note that you will have to build, push and publish your game server image, for it to be useable
-in a Snapend fleet.
-
-```
-# Help for the byosnap command
-snapctl byogs create --help
-
-# Create a new snap
-# $byogs_sid = Game server ID for your snap. Should start with `byogs-`
-# $name = User friendly name for your BYOGs
-# $desc = User friendly description
-# $platform = Currently only supported platform is linux/amd64
-# $language = One of go, python, ruby, c#, c++, rust, java, node
-
-# Example:
-# snapctl byogs create byosnap-jinks-gs --name "Jinks Flask Microservice" --desc "Custom Microservice" --platform "linux/arm64" --language "go"
-snapctl byogs create $byogs_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
-```
-
-#### 3. byogs build
+#### 2. byogs build
 
 Build your custom game server image.
 
@@ -335,15 +316,14 @@ Build your custom game server image.
 snapctl byogs build --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # Example:
 # snapctl byogs build byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs build $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byogs build --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byogs push
+#### 3. byogs push
 
 Push your custom game server image.
 
@@ -352,51 +332,13 @@ Push your custom game server image.
 snapctl byogs push --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # Example:
 # snapctl byogs push byosnap-jinks-gs --tag my-first-image
-snapctl byogs push $byogs_sid --tag $image_tag
+snapctl byogs push --tag $image_tag
 ```
 
-#### 5. [Deprecated soon] byogs publish-image
-
-Publish your custom game server image. This command executes, `build` and `push` one after the other.
-
-```
-# Help for the byogs command
-snapctl byogs publish-image --help
-
-# Publish a new image
-# $byogs_sid = Game server ID for your snap
-# $image_tag = An image tag for your snap
-# $code_root_path = Local code path where your Dockerfile is present
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs publish-image $byogs_sid --tag $image_tag --path $code_root_path
-```
-
-#### 6. [Deprecated soon] byogs publish-version
-
-Publish a new version for your game server. Only after your game server version is published, you will be able
-to use it in your Snapend fleet. This command should be run after you `push` or `publish-image` commands.
-
-```
-# Help for the byogs command
-snapctl byogs publish-version --help
-
-# Publish a new image
-# $byogs_sid = Snap ID for your snap
-# $image_tag = Any image tag for your snap
-# $prefix = Prefix for your snap Eg: /v1
-# $version = Semantic version for your snap Eg: v0.0.1
-# $ingress_port = Ingress port for your snap Eg: 5003
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
-snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
-```
-
-#### 7. [New] byogs publish
+#### 4. byogs publish
 
 Publish your custom game server image. This commend replaces the old way of creating, publishing image and
 then publishing the byogs. Now all you have to do is publish your image and create a fleet using the web portal.
@@ -546,3 +488,91 @@ snapctl snapend state --help
 snapctl snapend state $snapend_id
 ```
 
+## Error codes
+### CLI Return Codes
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 0          | Operation completed successfully                         |
+| 1          | General error                                            |
+| 2          | Input error                                              |
+
+### Configuration Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 10         | Configuration incorrect                                  |
+| 11         | Configuration error                                      |
+| 12         | Dependency missing                                       |
+
+### BYOGS Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 20         | Generic BYOGS error                                      |
+| 21         | BYOGS dependency missing                                 |
+| 22         | BYOGS ECR login error                                    |
+| 23         | BYOGS build error                                        |
+| 24         | BYOGS tag error                                          |
+| 25         | BYOGS publish error                                      |
+| 26         | BYOGS publish permission error                           |
+| 27         | BYOGS publish duplicate tag error                        |
+
+### BYOSNAP Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 30         | Generic BYOSNAP error                                    |
+| 31         | BYOSNAP dependency missing                               |
+| 32         | BYOSNAP ECR login error                                  |
+| 33         | BYOSNAP build error                                      |
+| 34         | BYOSNAP tag error                                        |
+| 35         | BYOSNAP publish image error                              |
+| 36         | BYOSNAP publish image permission error                   |
+| 37         | BYOSNAP publish image duplicate tag error                |
+| 38         | BYOSNAP create error                                     |
+| 39         | BYOSNAP create permission error                          |
+| 40         | BYOSNAP create duplicate name error                      |
+| 41         | BYOSNAP publish version error                            |
+| 42         | BYOSNAP publish version permission error                 |
+| 43         | BYOSNAP publish version duplicate version error          |
+| 44         | BYOSNAP publish version duplicate tag error              |
+
+### Game Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 50         | Generic game error                                       |
+| 51         | Game create error                                        |
+| 52         | Game create permission error                             |
+| 53         | Game create duplicate name error                         |
+| 54         | Game enumerate error                                     |
+
+### Snapend Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 60         | Generic snapend error                                    |
+| 61         | Snapend enumerate error                                  |
+| 62         | Snapend clone error                                      |
+| 63         | Snapend clone server error                               |
+| 64         | Snapend clone timeout error                              |
+| 65         | Snapend apply error                                      |
+| 66         | Snapend apply server error                               |
+| 67         | Snapend apply timeout error                              |
+| 68         | Snapend promote error                                    |
+| 69         | Snapend promote server error                             |
+| 70         | Snapend promote timeout error                            |
+| 71         | Snapend download error                                   |
+| 72         | Snapend update error                                     |
+| 73         | Snapend update server error                              |
+| 74         | Snapend update timeout error                             |
+| 75         | Snapend state error                                      |
+
+### Generate Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 80         | Generic generate error                                   |
+| 81         | Generate BYOSNAP profile error                           |
+

{snapctl-0.31.1 → snapctl-0.32.1}/README.md

@@ -227,16 +227,16 @@ snapctl byosnap push $byosnap_sid --tag $image_tag
 Upload swagger.json and README.md for you Snap
 
 ```
-# Help for the byogs command
+# Help for the byosnap command
 snapctl byosnap upload-docs --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
+# $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your swagger.json and README.md files are present
 # Example:
 # snapctl byosnap upload-docs byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap upload-docs $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --path $code_root_path
 ```
 
 #### 6. byosnap publish-image
@@ -288,28 +288,7 @@ See all the supported commands
 snapctl byogs --help
 ```
 
-#### 2. [Deprecated soon] byogs create
-
-Create a custom game server. Note that you will have to build, push and publish your game server image, for it to be useable
-in a Snapend fleet.
-
-```
-# Help for the byosnap command
-snapctl byogs create --help
-
-# Create a new snap
-# $byogs_sid = Game server ID for your snap. Should start with `byogs-`
-# $name = User friendly name for your BYOGs
-# $desc = User friendly description
-# $platform = Currently only supported platform is linux/amd64
-# $language = One of go, python, ruby, c#, c++, rust, java, node
-
-# Example:
-# snapctl byogs create byosnap-jinks-gs --name "Jinks Flask Microservice" --desc "Custom Microservice" --platform "linux/arm64" --language "go"
-snapctl byogs create $byogs_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
-```
-
-#### 3. byogs build
+#### 2. byogs build
 
 Build your custom game server image.
 
@@ -318,15 +297,14 @@ Build your custom game server image.
 snapctl byogs build --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # Example:
 # snapctl byogs build byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs build $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byogs build --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byogs push
+#### 3. byogs push
 
 Push your custom game server image.
 
@@ -335,51 +313,13 @@ Push your custom game server image.
 snapctl byogs push --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # Example:
 # snapctl byogs push byosnap-jinks-gs --tag my-first-image
-snapctl byogs push $byogs_sid --tag $image_tag
+snapctl byogs push --tag $image_tag
 ```
 
-#### 5. [Deprecated soon] byogs publish-image
-
-Publish your custom game server image. This command executes, `build` and `push` one after the other.
-
-```
-# Help for the byogs command
-snapctl byogs publish-image --help
-
-# Publish a new image
-# $byogs_sid = Game server ID for your snap
-# $image_tag = An image tag for your snap
-# $code_root_path = Local code path where your Dockerfile is present
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs publish-image $byogs_sid --tag $image_tag --path $code_root_path
-```
-
-#### 6. [Deprecated soon] byogs publish-version
-
-Publish a new version for your game server. Only after your game server version is published, you will be able
-to use it in your Snapend fleet. This command should be run after you `push` or `publish-image` commands.
-
-```
-# Help for the byogs command
-snapctl byogs publish-version --help
-
-# Publish a new image
-# $byogs_sid = Snap ID for your snap
-# $image_tag = Any image tag for your snap
-# $prefix = Prefix for your snap Eg: /v1
-# $version = Semantic version for your snap Eg: v0.0.1
-# $ingress_port = Ingress port for your snap Eg: 5003
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
-snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
-```
-
-#### 7. [New] byogs publish
+#### 4. byogs publish
 
 Publish your custom game server image. This commend replaces the old way of creating, publishing image and
 then publishing the byogs. Now all you have to do is publish your image and create a fleet using the web portal.
@@ -528,3 +468,91 @@ snapctl snapend state --help
 # snapctl snapend state gx5x6bc0
 snapctl snapend state $snapend_id
 ```
+
+## Error codes
+### CLI Return Codes
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 0          | Operation completed successfully                         |
+| 1          | General error                                            |
+| 2          | Input error                                              |
+
+### Configuration Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 10         | Configuration incorrect                                  |
+| 11         | Configuration error                                      |
+| 12         | Dependency missing                                       |
+
+### BYOGS Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 20         | Generic BYOGS error                                      |
+| 21         | BYOGS dependency missing                                 |
+| 22         | BYOGS ECR login error                                    |
+| 23         | BYOGS build error                                        |
+| 24         | BYOGS tag error                                          |
+| 25         | BYOGS publish error                                      |
+| 26         | BYOGS publish permission error                           |
+| 27         | BYOGS publish duplicate tag error                        |
+
+### BYOSNAP Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 30         | Generic BYOSNAP error                                    |
+| 31         | BYOSNAP dependency missing                               |
+| 32         | BYOSNAP ECR login error                                  |
+| 33         | BYOSNAP build error                                      |
+| 34         | BYOSNAP tag error                                        |
+| 35         | BYOSNAP publish image error                              |
+| 36         | BYOSNAP publish image permission error                   |
+| 37         | BYOSNAP publish image duplicate tag error                |
+| 38         | BYOSNAP create error                                     |
+| 39         | BYOSNAP create permission error                          |
+| 40         | BYOSNAP create duplicate name error                      |
+| 41         | BYOSNAP publish version error                            |
+| 42         | BYOSNAP publish version permission error                 |
+| 43         | BYOSNAP publish version duplicate version error          |
+| 44         | BYOSNAP publish version duplicate tag error              |
+
+### Game Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 50         | Generic game error                                       |
+| 51         | Game create error                                        |
+| 52         | Game create permission error                             |
+| 53         | Game create duplicate name error                         |
+| 54         | Game enumerate error                                     |
+
+### Snapend Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 60         | Generic snapend error                                    |
+| 61         | Snapend enumerate error                                  |
+| 62         | Snapend clone error                                      |
+| 63         | Snapend clone server error                               |
+| 64         | Snapend clone timeout error                              |
+| 65         | Snapend apply error                                      |
+| 66         | Snapend apply server error                               |
+| 67         | Snapend apply timeout error                              |
+| 68         | Snapend promote error                                    |
+| 69         | Snapend promote server error                             |
+| 70         | Snapend promote timeout error                            |
+| 71         | Snapend download error                                   |
+| 72         | Snapend update error                                     |
+| 73         | Snapend update server error                              |
+| 74         | Snapend update timeout error                             |
+| 75         | Snapend state error                                      |
+
+### Generate Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 80         | Generic generate error                                   |
+| 81         | Generate BYOSNAP profile error                           |

{snapctl-0.31.1 → snapctl-0.32.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snapctl"
-version = "0.31.1"
+version = "0.32.1"
 description = "Snapser CLI Tool"
 authors = ["Ajinkya Apte <aj@snapser.com>"]
 readme = "README.md"
@@ -11,10 +11,12 @@ snapctl = "snapctl.main:app"
 
 [tool.poetry.dependencies]
 python = "^3.10"
-typer = {extras = ["all"], version = "^0.7.0"}
+typer = {extras = ["all"], version = "^0.12.3"}
 requests = "^2.28.2"
 configparser = "^6.0.0"
 pyfiglet = "^1.0.2"
+pytest = "^8.2.2"
+pytest-mock = "^3.14.0"
 
 
 [build-system]