refactor(create-preview/delete-preview)!: introduce new create-pr-preview and delete-pr-preview commands and refactor old create-preview and delete-preview to use different approach create-pr-preview: handles deployment of preview env and chatops (comments in the pr) create-preview: only handled deployment of the preview env delete-pr-preview: deletes deployment of preview env which was created with create-pr-preview command delete-preview: deletes deployment of preview env which was created with create-preview command BREAKING CHANGE: if you used create-preview you now need to switch to create-pr-preview, if you used delete-preview you now need to switch to delete-pr-preview command

Create preview refactoring

Author: m4rc0z

.gitpod.yml

@@ -1,2 +1,2 @@
 tasks:
-  - init: make init && gitopscli --help
+  - init: make init && export COLUMNS=80 && gitopscli --help

docs/commands/create-pr-preview.md

@@ -0,0 +1,108 @@
+# create-pr-preview
+
+The `create-pr-preview` command can be used to create a preview environment in your *deployment config repository* for a pull request of your *app repository*. You can later easily delete this preview with the [`delete-pr-preview` command](/gitopscli/commands/delete-pr-preview/).
+
+You need to provide some additional configuration files in your repositories for this command to work. 
+
+## Configuration
+### Preview Templates
+
+Your *deployment config repository* needs to contain a `.preview-templates` folder with the deployment configuration templates for every application you want to use this command for.
+
+For example you have to provide `.preview-templates/app-xy` for your app `app-xy`. The `create-pr-preview` command simply copies this directory to the root of the repository. Only image tag and route host will be replaced in the preview version of the deployment.
+
+```
+deployment-config-repo/
+├── .preview-templates
+│   └── app-xy
+│       ├── values.yaml
+│       └── some-more-config-files-or-folders
+├── app-xy-production
+├── app-xy-staging
+├── app-xy-test
+└── app-xy-c7003101-preview  <- This is how a created preview looks like
+    ├── values.yaml          <- image tag and route host are replaced in this one
+    └── some-more-config-files-or-folders
+```
+
+!!! info "Currently you have to specify image tag and route host in a `values.yaml` file. We are working on making this configurable in the future."
+
+### .gitops.config.yaml
+
+Make sure that your *app repository* contains a `.gitops.config.yaml` file. This file provides all information to 
+
+1. find the *deployment config repository*
+2. locate the preview template for your app
+3. replace image tag and route host in the template
+
+```yaml
+deploymentConfig:
+  # The organisation name of your deployment repo
+  org: deployments
+  # The repostiory name of your deployment repo
+  repository: deployment-config-repo
+  # The name of the application (name of the folder in `.preview-templates`)
+  applicationName: app-xy
+
+previewConfig:
+  route:
+    host:
+      # Your router host
+      # {SHA256_8CHAR_BRANCH_HASH} gets replaced by a shortened hash of your feature branch name
+      template: app.xy-{SHA256_8CHAR_BRANCH_HASH}.example.tld
+  replace:
+    # Paths that should be replaced in the `values.yaml`
+    - path: image.tag
+      variable: GIT_COMMIT # this is the latest git hash of the pull request branch
+    - path: route.host
+      variable: ROUTE_HOST # this is the resolved host.template from above
+```
+
+## Example
+
+```bash
+gitopscli create-pr-preview \
+  --git-provider-url https://bitbucket.baloise.dev \
+  --username $GIT_USERNAME \
+  --password $GIT_PASSWORD \
+  --git-user "GitOps CLI" \
+  --git-email "[email protected]" \
+  --organisation "my-team" \
+  --repository-name "app-xy" \
+  --pr-id 4711 \
+  --create-pr \
+  --auto-merge
+```
+
+## Usage
+```
+usage: gitopscli create-pr-preview [-h] --username USERNAME --password PASSWORD
+                                [--git-user GIT_USER] [--git-email GIT_EMAIL]
+                                --organisation ORGANISATION --repository-name
+                                REPOSITORY_NAME [--git-provider GIT_PROVIDER]
+                                [--git-provider-url GIT_PROVIDER_URL]
+                                --pr-id PR_ID
+                                [--parent-id PARENT_ID] [-v [VERBOSE]]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --username USERNAME   Git username
+  --password PASSWORD   Git password or token
+  --git-user GIT_USER   Git Username
+  --git-email GIT_EMAIL
+                        Git User Email
+  --organisation ORGANISATION
+                        Apps Git organisation/projectKey
+  --repository-name REPOSITORY_NAME
+                        Git repository name (not the URL, e.g. my-repo)
+  --git-provider GIT_PROVIDER
+                        Git server provider
+  --git-provider-url GIT_PROVIDER_URL
+                        Git provider base API URL (e.g.
+                        https://bitbucket.example.tld)
+  --pr-id PR_ID         the id of the pull request
+  --parent-id PARENT_ID
+                        the id of the parent comment, in case of a reply
+  -v [VERBOSE], --verbose [VERBOSE]
+                        Verbose exception logging
+```

docs/commands/create-preview.md

@@ -1,6 +1,6 @@
 # create-preview
 
-The `create-preview` command can be used to create a preview environment in your *deployment config repository* for a pull request in you *app repository*. You can later easily delete this preview with the [`delete-preview` command](/gitopscli/commands/delete-preview/).
+The `create-preview` command can be used to create a preview environment in your *deployment config repository* for a commit hash of your *app repository*. You can later easily delete this preview with the [`delete-preview` command](/gitopscli/commands/delete-preview/).
 
 You need to provide some additional configuration files in your repositories for this command to work. 
 
@@ -48,12 +48,12 @@ previewConfig:
   route:
     host:
       # Your router host
-      # {SHA256_8CHAR_BRANCH_HASH} gets replaced by a shortened hash of your feature branch name
+      # {SHA256_8CHAR_BRANCH_HASH} gets replaced by a shortened hash of your preview_id
       template: app.xy-{SHA256_8CHAR_BRANCH_HASH}.example.tld
   replace:
     # Paths that should be replaced in the `values.yaml`
     - path: image.tag
-      variable: GIT_COMMIT # this is the latest git hash of the pull request branch
+      variable: GIT_COMMIT # this is the git hash of your app repo
     - path: route.host
       variable: ROUTE_HOST # this is the resolved host.template from above
 ```
@@ -69,9 +69,8 @@ gitopscli create-preview \
   --git-email "[email protected]" \
   --organisation "my-team" \
   --repository-name "app-xy" \
-  --pr-id 4711 \
-  --create-pr \
-  --auto-merge
+  --git-hash "c0784a34e834117e1489973327ff4ff3c2582b94" \
+  --preview-id "test-preview-id" \
 ```
 
 ## Usage
@@ -81,9 +80,8 @@ usage: gitopscli create-preview [-h] --username USERNAME --password PASSWORD
                                 --organisation ORGANISATION --repository-name
                                 REPOSITORY_NAME [--git-provider GIT_PROVIDER]
                                 [--git-provider-url GIT_PROVIDER_URL]
-                                [--create-pr [CREATE_PR]]
-                                [--auto-merge [AUTO_MERGE]] --pr-id PR_ID
-                                [--parent-id PARENT_ID] [-v [VERBOSE]]
+                                --preview-id PREVIEW_ID
+                                [-v [VERBOSE]]
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -101,14 +99,8 @@ optional arguments:
   --git-provider-url GIT_PROVIDER_URL
                         Git provider base API URL (e.g.
                         https://bitbucket.example.tld)
-  --create-pr [CREATE_PR]
-                        Creates a Pull Request
-  --auto-merge [AUTO_MERGE]
-                        Automatically merge the created PR (only valid with
-                        --create-pr)
-  --pr-id PR_ID         the id of the pull request
-  --parent-id PARENT_ID
-                        the id of the parent comment, in case of a reply
+  --git-hash GIT_HASH         the git hash of the app repo which should be deployed
+  --preview-id PREVIEW_ID         the id of the created preview environment
   -v [VERBOSE], --verbose [VERBOSE]
                         Verbose exception logging
 ```

docs/commands/delete-pr-preview.md

@@ -0,0 +1,48 @@
+# delete-pr-preview
+
+The `delete-pr-preview` command can be used to delete a preview previously created with the [`create-pr-preview` command](/gitopscli/commands/create-pr-preview/). Please refer to `create-pr-preview` documentation for the needed configuration files.
+
+## Example
+
+```bash
+gitopscli delete-pr-preview \
+  --git-provider-url https://bitbucket.baloise.dev \
+  --username $GIT_USERNAME \
+  --password $GIT_PASSWORD \
+  --git-user "GitOps CLI" \
+  --git-email "[email protected]" \
+  --organisation "my-team" \
+  --repository-name "app-xy" \
+  --branch "my-pr-branch" \
+```
+
+## Usage
+```
+usage: gitopscli delete-pr-preview [-h] --username USERNAME --password PASSWORD
+                                [--git-user GIT_USER] [--git-email GIT_EMAIL]
+                                --organisation ORGANISATION --repository-name
+                                REPOSITORY_NAME [--git-provider GIT_PROVIDER]
+                                [--git-provider-url GIT_PROVIDER_URL] --branch
+                                BRANCH
+                                [-v [VERBOSE]]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --username USERNAME   Git username
+  --password PASSWORD   Git password or token
+  --git-user GIT_USER   Git Username
+  --git-email GIT_EMAIL
+                        Git User Email
+  --organisation ORGANISATION
+                        Apps Git organisation/projectKey
+  --repository-name REPOSITORY_NAME
+                        Git repository name (not the URL, e.g. my-repo)
+  --git-provider GIT_PROVIDER
+                        Git server provider
+  --git-provider-url GIT_PROVIDER_URL
+                        Git provider base API URL (e.g.
+                        https://bitbucket.example.tld)
+  --branch BRANCH       The branch for which the preview was created for
+  -v [VERBOSE], --verbose [VERBOSE]
+                        Verbose exception logging
+```

docs/commands/delete-preview.md

@@ -13,9 +13,7 @@ gitopscli delete-preview \
   --git-email "[email protected]" \
   --organisation "my-team" \
   --repository-name "app-xy" \
-  --branch "my-pr-branch" \
-  --create-pr \
-  --auto-merge
+  --preview-id "test123" \
 ```
 
 ## Usage
@@ -24,9 +22,9 @@ usage: gitopscli delete-preview [-h] --username USERNAME --password PASSWORD
                                 [--git-user GIT_USER] [--git-email GIT_EMAIL]
                                 --organisation ORGANISATION --repository-name
                                 REPOSITORY_NAME [--git-provider GIT_PROVIDER]
-                                [--git-provider-url GIT_PROVIDER_URL] --branch
-                                BRANCH [--create-pr [CREATE_PR]]
-                                [--auto-merge [AUTO_MERGE]] [-v [VERBOSE]]
+                                [--git-provider-url GIT_PROVIDER_URL] --preview-id
+                                PREVIEW_ID
+                                [-v [VERBOSE]]
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -44,12 +42,7 @@ optional arguments:
   --git-provider-url GIT_PROVIDER_URL
                         Git provider base API URL (e.g.
                         https://bitbucket.example.tld)
-  --branch BRANCH       The branch for which the preview was created for
-  --create-pr [CREATE_PR]
-                        Creates a Pull Request
-  --auto-merge [AUTO_MERGE]
-                        Automatically merge the created PR (only valid with
-                        --create-pr)
+  --preview-id PREVIEW_ID   The preview id for which the preview was created for
   -v [VERBOSE], --verbose [VERBOSE]
                         Verbose exception logging
 ```

gitopscli/__main__.py

@@ -4,11 +4,13 @@
 from gitopscli.cliparser import create_cli
 from gitopscli.commands import (
     pr_comment_command,
+    create_pr_preview_command,
     create_preview_command,
     delete_preview_command,
     deploy_command,
     sync_apps_command,
     version_command,
+    delete_pr_preview_command,
 )
 from gitopscli.gitops_exception import GitOpsException
 
@@ -17,18 +19,7 @@ def main():
     logging.basicConfig(level=logging.INFO, format="%(levelname)-2s %(funcName)s: %(message)s")
     args = create_cli(sys.argv[1:])
 
-    if args.command == "deploy":
-        command = deploy_command
-    elif args.command == "sync-apps":
-        command = sync_apps_command
-    elif args.command == "add-pr-comment":
-        command = pr_comment_command
-    elif args.command == "create-preview":
-        command = create_preview_command
-    elif args.command == "delete-preview":
-        command = delete_preview_command
-    elif args.command == "version":
-        command = version_command
+    command = get_command(args.command)
 
     if "verbose" in args:
         verbose = args.verbose
@@ -48,3 +39,24 @@ def main():
 
 if __name__ == "__main__":
     main()
+
+
+def get_command(command):
+    command_func = None
+    if command == "deploy":
+        command_func = deploy_command
+    elif command == "sync-apps":
+        command_func = sync_apps_command
+    elif command == "add-pr-comment":
+        command_func = pr_comment_command
+    elif command == "create-pr-preview":
+        command_func = create_pr_preview_command
+    elif command == "create-preview":
+        command_func = create_preview_command
+    elif command == "delete-pr-preview":
+        command_func = delete_pr_preview_command
+    elif command == "delete-preview":
+        command_func = delete_preview_command
+    elif command == "version":
+        command_func = version_command
+    return command_func

gitopscli/cliparser.py

@@ -10,7 +10,9 @@ def create_cli(args):
     __add_sync_apps_command_parser(subparsers)
     __add_pr_comment_command_parser(subparsers)
     __add_create_preview_command_parser(subparsers)
+    __add_create_pr_preview_command_parser(subparsers)
     __add_delete_preview_command_parser(subparsers)
+    __add_delete_pr_preview_command_parser(subparsers)
     __add_version_command_parser(subparsers)
 
     if len(args) == 0:
@@ -68,20 +70,34 @@ def __add_pr_comment_command_parser(subparsers):
 
 
 def __add_create_preview_command_parser(subparsers):
-    add_create_preview_p = subparsers.add_parser("create-preview", help="Create a preview environment")
-    __add_git_parser_args(add_create_preview_p)
-    __add_branch_pr_parser_args(add_create_preview_p)
-    __add_create_prid_parser(add_create_preview_p)
-    __add_verbose_parser(add_create_preview_p)
+    add_create_preview_common_p = subparsers.add_parser("create-preview", help="Create a preview environment")
+    __add_git_parser_args(add_create_preview_common_p)
+    __add_create_githash_previewid_parser(add_create_preview_common_p)
+    __add_verbose_parser(add_create_preview_common_p)
+
+
+def __add_create_pr_preview_command_parser(subparsers):
+    add_create_pr_preview_p = subparsers.add_parser("create-pr-preview", help="Create a preview environment")
+    __add_git_parser_args(add_create_pr_preview_p)
+    __add_create_prid_parser(add_create_pr_preview_p)
+    __add_verbose_parser(add_create_pr_preview_p)
 
 
 def __add_delete_preview_command_parser(subparsers):
     add_delete_preview_p = subparsers.add_parser("delete-preview", help="Delete a preview environment")
     __add_git_parser_args(add_delete_preview_p)
+    add_delete_preview_p.add_argument(
+        "--preview-id", help="The preview-id for which the preview was created for", required=True
+    )
+    __add_verbose_parser(add_delete_preview_p)
+
+
+def __add_delete_pr_preview_command_parser(subparsers):
+    add_delete_preview_p = subparsers.add_parser("delete-pr-preview", help="Delete a pr preview environment")
+    __add_git_parser_args(add_delete_preview_p)
     add_delete_preview_p.add_argument(
         "--branch", help="The branch for which the preview was created for", required=True
     )
-    __add_branch_pr_parser_args(add_delete_preview_p)
     __add_verbose_parser(add_delete_preview_p)
 
 
@@ -115,6 +131,13 @@ def __add_branch_pr_parser_args(deploy_p):
     )
 
 
+def __add_create_githash_previewid_parser(subparsers):
+    subparsers.add_argument("--git-hash", help="the git hash which should be deployed", type=str, required=True)
+    subparsers.add_argument(
+        "--preview-id", help="the id of folder in the config repo which will be created", type=str, required=True
+    )
+
+
 def __add_create_prid_parser(subparsers):
     subparsers.add_argument("--pr-id", help="the id of the pull request", type=int, required=True)
     subparsers.add_argument("--parent-id", help="the id of the parent comment, in case of a reply", type=int)