Enabling spk ring commands, documentation, smoke tests

Author: mtarng

docs/commands/data.json

@@ -476,6 +476,24 @@
     ],
     "markdown": "## Description\n\nDeploy the HLD Lifecycle pipeline for the bedrock project. This should be run\nafter merging the `hld-lifecycle.yaml` generated by `spk project init` to the\nproject repository to master. The command will add the required pipeline\nvariables.\n"
   },
+  "ring create": {
+    "command": "create <ring-name>",
+    "alias": "c",
+    "description": "Create a new ring for the current working directory project repository. This will affect all services within the project repository.",
+    "markdown": "## Description\n\nSPK command to create a ring into an initialized bedrock project.\n\n## Example\n\nFor a bedrock.yaml file that looks like this:\n\n```yaml\nrings:\n  dev:\n    isDefault: true\n  qa:\n  prod:\nservices:\n  ./:\n    displayName: \"fabrikam\"\n    helm:\n      chart:\n        branch: master\n        git: \"https://dev.azure.com/fabrikam/frontend/_git/charts\"\n        path: frontend\n    k8sBackend: \"fabrikam-k8s-svc\"\n    k8sBackendPort: 80\n    middlewares: []\n    pathPrefix: \"fabrikam-service\"\n    pathPrefixMajorVersion: \"v1\"\nvariableGroups:\n  - fabrikam-vg\n```\n\nrunning `spk ring create stage` will result in a few changes:\n\n1. `stage` will be added into `bedrock.yaml` rings component:\n   ```yaml\n   rings:\n   dev:\n     isDefault: true\n   qa:\n   prod:\n   stage:\n   services:\n   ./:\n     displayName: \"fabrikam\"\n     helm:\n     chart:\n       branch: master\n       git: \"https://dev.azure.com/fabrikam/frontend/_git/charts\"\n       path: frontend\n     k8sBackend: \"fabrikam-k8s-svc\"\n     k8sBackendPort: 80\n     middlewares: []\n     pathPrefix: \"fabrikam-service\"\n     pathPrefixMajorVersion: \"v1\"\n   variableGroups:\n     - fabrikam-vg\n   ```\n2. Each of the referenced services within `bedrock.yaml` will have their\n   `build-update-hld.yaml` updated to include the new ring, `stage` in their\n   branch triggers:\n\n   ```yaml\n    trigger:\n    branches:\n        include:\n        - dev\n        - qa\n        - prod\n        - stage <-- NEW -->\n    variables:\n    - group: fabrikam-vg\n    …\n   ```\n\n3. Commiting these changes will trigger the project's lifecycle pipeline, which\n   will then scaffold out the newly created ring, along with the appropriate\n   IngressRoutes in the linked HLD repository.\n"
+  },
+  "ring delete": {
+    "command": "delete <ring-name>",
+    "alias": "d",
+    "description": "Delete a ring from the current working directory project repository. This will affect all services within the project repository. The default ring cannot be deleted.",
+    "markdown": "## Description\n\nSPK command to remove a ring from an initialized bedrock project.\n\n_Note:_ A default ring cannot be removed. First set another ring as the default\nvia `spk ring set-default` before deleting.\n\n## Example\n\nFor a bedrock.yaml file that looks like this:\n\n```yaml\nrings:\n  dev:\n    isDefault: true\n  qa:\n  prod:\nservices:\n  ./:\n    displayName: \"fabrikam\"\n    helm:\n      chart:\n        branch: master\n        git: \"https://dev.azure.com/fabrikam/frontend/_git/charts\"\n        path: frontend\n    k8sBackend: \"fabrikam-k8s-svc\"\n    k8sBackendPort: 80\n    middlewares: []\n    pathPrefix: \"fabrikam-service\"\n    pathPrefixMajorVersion: \"v1\"\nvariableGroups:\n  - fabrikam-vg\n```\n\nrunning `spk ring delete prod` will result in a few changes:\n\n1. `prod` will be removed from `bedrock.yaml`:\n   ```yaml\n   rings:\n   dev:\n     isDefault: true\n   qa:\n   services:\n   ./:\n     displayName: \"fabrikam\"\n     helm:\n     chart:\n       branch: master\n       git: \"https://dev.azure.com/fabrikam/frontend/_git/charts\"\n       path: frontend\n     k8sBackend: \"fabrikam-k8s-svc\"\n     k8sBackendPort: 80\n     middlewares: []\n     pathPrefix: \"fabrikam-service\"\n     pathPrefixMajorVersion: \"v1\"\n   variableGroups:\n     - fabrikam-vg\n   ```\n2. Each of the referenced services within `bedrock.yaml` will have their\n   `build-update-hld.yaml` updated to remove the ring, `prod` in their branch\n   triggers:\n\n   ```yaml\n    trigger:\n    branches:\n        include:\n        - dev\n        - qa\n        # - prod <-- THIS WILL BE DELETED! -->\n    variables:\n    - group: fabrikam-vg\n    …\n   ```\n\n3. Commiting these changes will trigger the project's lifecycle pipeline, which\n   will then remove the ring from linked services in this project,\n   [pending this epic](https://github.com/microsoft/bedrock/issues/858).\n"
+  },
+  "ring set-default": {
+    "command": "set-default <ring-name>",
+    "alias": "s",
+    "description": "Set a ring as the default for the current working directory project repository. This will affect all services within the project repository.",
+    "markdown": "## Description\n\nSPK command to set a ring as the default for an initialized bedrock project.\n\n## Example\n\nFor a bedrock.yaml file that looks like this:\n\n```yaml\nrings:\n  dev:\n    isDefault: true\n  qa:\n  prod:\nservices:\n  ./:\n    displayName: \"fabrikam\"\n    helm:\n      chart:\n        branch: master\n        git: \"https://dev.azure.com/fabrikam/frontend/_git/charts\"\n        path: frontend\n    k8sBackend: \"fabrikam-k8s-svc\"\n    k8sBackendPort: 80\n    middlewares: []\n    pathPrefix: \"fabrikam-service\"\n    pathPrefixMajorVersion: \"v1\"\nvariableGroups:\n  - fabrikam-vg\n```\n\nrunning `spk ring set-default prod` will result in:\n\n1. `prod` will be set as the default in `bedrock.yaml`:\n\n   ```yaml\n   rings:\n   dev:\n   qa:\n   prod:\n     isDefault: true\n   services:\n   ./:\n     displayName: \"fabrikam\"\n     helm:\n     chart:\n       branch: master\n       git: \"https://dev.azure.com/fabrikam/frontend/_git/charts\"\n       path: frontend\n     k8sBackend: \"fabrikam-k8s-svc\"\n     k8sBackendPort: 80\n     middlewares: []\n     pathPrefix: \"fabrikam-service\"\n     pathPrefixMajorVersion: \"v1\"\n   variableGroups:\n     - fabrikam-vg\n   ```\n\n2. Commiting these changes will trigger the project's lifecycle pipeline, which\n   may update the default \"no-ring\" IngressRoutes to route to the `prod` service\n   in the linked HLD repository,\n   [pending the work in this issue](https://github.com/microsoft/bedrock/issues/1084).\n"
+  },
   "service create-revision": {
     "command": "create-revision",
     "alias": "cr",

src/commands/ring/create.decorator.json

@@ -1,6 +1,5 @@
 {
   "command": "create <ring-name>",
   "alias": "c",
-  "description": "Create a new ring for the current working directory project repository. This will affect all services within the project repository.",
-  "disabled": true
+  "description": "Create a new ring for the current working directory project repository. This will affect all services within the project repository."
 }

src/commands/ring/delete.decorator.json

@@ -1,6 +1,5 @@
 {
   "command": "delete <ring-name>",
   "alias": "d",
-  "description": "Delete a ring from the current working directory project repository. This will affect all services within the project repository. The default ring cannot be deleted.",
-  "disabled": true
+  "description": "Delete a ring from the current working directory project repository. This will affect all services within the project repository. The default ring cannot be deleted."
 }

src/commands/ring/set-default.decorator.json

@@ -1,6 +1,5 @@
 {
   "command": "set-default <ring-name>",
   "alias": "s",
-  "description": "Set a ring as the default for the current working directory project repository. This will affect all services within the project repository.",
-  "disabled": true
+  "description": "Set a ring as the default for the current working directory project repository. This will affect all services within the project repository."
 }

src/index.ts

@@ -25,7 +25,7 @@ const commandModules = [
   "hld",
   "infra",
   "project",
-  // "ring", // Uncomment when ready to add rings
+  "ring",
   "service",
   "variable-group",
 ];

tests/.gitignore

@@ -1,2 +1,3 @@
 spk-env/
-infra-generation-pipeline.yml
+infra-generation-pipeline.yml
+file.json

tests/validations.sh

@@ -356,92 +356,92 @@ validate_file "$TEST_WORKSPACE/$manifests_dir/prod/$mono_repo_dir/$FrontEndCompl
 # Get the current pipeline/build id at this stage. This will be used by the introspection integration test.
 pipeline1id=$(az pipelines build list --definition-ids $pipeline_id --organization $AZDO_ORG_URL --project $AZDO_PROJECT | jq '.[0].id')
 
-# ##################################
-# # App Mono Repo create ring
-# ##################################
-# echo "Create ring in mono repo"
-# verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $lifecycle_pipeline_name 400 15 2
-# echo "Finding pull request that $lifecycle_pipeline_name pipeline created..."
-# approve_pull_request $AZDO_ORG_URL $AZDO_PROJECT "Reconciling HLD"
+##################################
+# App Mono Repo create ring
+##################################
+echo "Create ring in mono repo"
+verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $lifecycle_pipeline_name 400 15 2
+echo "Finding pull request that $lifecycle_pipeline_name pipeline created..."
+approve_pull_request $AZDO_ORG_URL $AZDO_PROJECT "Reconciling HLD"
 
-# # Wait for fabrikam-hld-to-fabrikam-manifests pipeline to finish
-# echo "Wait for fabrikam-hld-to-fabrikam-manifests pipeline"
-# verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 500 15 4
-# ring_name=qa-ring
+# Wait for fabrikam-hld-to-fabrikam-manifests pipeline to finish
+echo "Wait for fabrikam-hld-to-fabrikam-manifests pipeline"
+verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 500 15 4
+ring_name=qa-ring
 
-# cd $TEST_WORKSPACE
-# cd $mono_repo_dir
+cd $TEST_WORKSPACE
+cd $mono_repo_dir
 
-# echo "Create ring"
-# git checkout master
-# git pull origin master
-# spk ring create $ring_name
-# git add -A
-# git commit -m "Adding test ring"
-# git push -u origin --all
+echo "Create ring"
+git checkout master
+git pull origin master
+spk ring create $ring_name
+git add -A
+git commit -m "Adding test ring"
+git push -u origin --all
 
-# # Wait for the lifecycle pipeline to finish and approve the pull request
-# verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $lifecycle_pipeline_name 300 15 3
-# echo "Finding pull request that $lifecycle_pipeline_name pipeline created..."
-# approve_pull_request $AZDO_ORG_URL $AZDO_PROJECT "Reconciling HLD"
+# Wait for the lifecycle pipeline to finish and approve the pull request
+verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $lifecycle_pipeline_name 300 15 3
+echo "Finding pull request that $lifecycle_pipeline_name pipeline created..."
+approve_pull_request $AZDO_ORG_URL $AZDO_PROJECT "Reconciling HLD"
 
-# # Wait for fabrikam-hld-to-fabrikam-manifests pipeline to finish
-# verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 300 15 5
+# Wait for fabrikam-hld-to-fabrikam-manifests pipeline to finish
+verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 300 15 5
 
-# # Verify the file was added in the manifest repository
-# cd $TEST_WORKSPACE
-# cd $manifests_dir
+# Verify the file was added in the manifest repository
+cd $TEST_WORKSPACE
+cd $manifests_dir
 
-# git pull origin master
+git pull origin master
 
-# ring_dir="prod/$mono_repo_dir/fabrikam-acme-frontend/$ring_name"
-# if [ ! -d "$ring_dir" ]; then
-#   echo "Directory '$ring_dir' does not exist"
-#   exit 1
-# fi
+ring_dir="prod/$mono_repo_dir/fabrikam-acme-frontend/$ring_name"
+if [ ! -d "$ring_dir" ]; then
+  echo "Directory '$ring_dir' does not exist"
+  exit 1
+fi
 
-# echo "Validating ingress routes"
+echo "Validating ingress routes"
 
-# validate_file "$ring_dir/static.yaml" "'PathPrefix(\`/fabrikam-acme-frontend\`) && Headers(\`Ring\`, \`qa-ring\`)'"
+validate_file "$ring_dir/static.yaml" "'PathPrefix(\`/fabrikam-acme-frontend\`) && Headers(\`Ring\`, \`qa-ring\`)'"
 
-# echo "Successfully created a ring."
+echo "Successfully created a ring."
 
-# ##################################
-# # App Mono Repo update ring
-# ##################################
-# echo "Update ring."
-# cd $TEST_WORKSPACE
-# cd $mono_repo_dir
-# git branch $ring_name
-# git checkout $ring_name
-# cd services/$FrontEnd
-# echo "Ring doc" >> ringDoc.md
-# git add ringDoc.md
-# git commit -m "Adding ring doc file"
-# git push --set-upstream origin $ring_name
-
-# # Verify frontend service pipeline run was successful
-# verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $frontend_pipeline_name 300 15 3
-# #complete merge
-# echo "Finding pull request that $frontend_pipeline_name pipeline created..."
-# approve_pull_request $AZDO_ORG_URL $AZDO_PROJECT "Updating fabrikam.acme.frontend image tag to qa-ring"
-
-# # Wait for fabrikam-hld-to-fabrikam-manifests pipeline to finish
-# echo "Wait for hld to fabrikam manifests"
-# verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 400 15 6
-
-# echo "Validating ring image tag in manifest repo"
-# cd $TEST_WORKSPACE/$hld_dir
-# git pull
-# cd $mono_repo_dir/$FrontEndCompliant/$ring_name/config
-# image_repository=$(grep -A3 'image:' common.yaml | tail -n3 | awk '{print $2}' | head -n1 )
-# image_tag=$(grep -A3 'image:' common.yaml | tail -n2 | awk '{print $2}' | head -n 1)
-# cd $TEST_WORKSPACE/$manifests_dir
-# git pull
-# validate_commit $image_tag
-# validate_file "$TEST_WORKSPACE/$manifests_dir/prod/$mono_repo_dir/$FrontEndCompliant/$ring_name/chart.yaml" "image: $image_repository:$image_tag"
-
-# echo "Successfully updated a ring."
+##################################
+# App Mono Repo update ring
+##################################
+echo "Update ring."
+cd $TEST_WORKSPACE
+cd $mono_repo_dir
+git branch $ring_name
+git checkout $ring_name
+cd services/$FrontEnd
+echo "Ring doc" >> ringDoc.md
+git add ringDoc.md
+git commit -m "Adding ring doc file"
+git push --set-upstream origin $ring_name
+
+# Verify frontend service pipeline run was successful
+verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $frontend_pipeline_name 300 15 3
+#complete merge
+echo "Finding pull request that $frontend_pipeline_name pipeline created..."
+approve_pull_request $AZDO_ORG_URL $AZDO_PROJECT "Updating fabrikam.acme.frontend image tag to qa-ring"
+
+# Wait for fabrikam-hld-to-fabrikam-manifests pipeline to finish
+echo "Wait for hld to fabrikam manifests"
+verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 400 15 6
+
+echo "Validating ring image tag in manifest repo"
+cd $TEST_WORKSPACE/$hld_dir
+git pull
+cd $mono_repo_dir/$FrontEndCompliant/$ring_name/config
+image_repository=$(grep -A3 'image:' common.yaml | tail -n3 | awk '{print $2}' | head -n1 )
+image_tag=$(grep -A3 'image:' common.yaml | tail -n2 | awk '{print $2}' | head -n 1)
+cd $TEST_WORKSPACE/$manifests_dir
+git pull
+validate_commit $image_tag
+validate_file "$TEST_WORKSPACE/$manifests_dir/prod/$mono_repo_dir/$FrontEndCompliant/$ring_name/chart.yaml" "image: $image_repository:$image_tag"
+
+echo "Successfully updated a ring."
 # --------------------------------
 
 echo "Successfully reached the end of the service validations scripts."
@@ -450,11 +450,9 @@ echo "Successfully reached the end of the service validations scripts."
 # SPK Introspection Validation START
 ##################################
 
-pipeline1id=$(az pipelines build list --definition-ids $pipeline_id --organization $AZDO_ORG_URL --project $AZDO_PROJECT | jq '.[0].id')
-
 # Verify hld to manifest pipeline run was successful, to verify the full end-end capture of
 # introspection data
-verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 300 15 3
+verify_pipeline_with_poll $AZDO_ORG_URL $AZDO_PROJECT $hld_to_manifest_pipeline_name 300 15 6
 
 cd $TEST_WORKSPACE
 cd ..