Added the blue/green project sample

mcasperson · mcasperson · commit 6972be8707c8 · 2025-10-14T09:41:25.000+10:00
diff --git a/context/vmbluegreen.tf b/context/vmbluegreen.tf
@@ -285,6 +285,28 @@ resource "octopusdeploy_environment" "environment_production" {
   }
 }
 
+data "octopusdeploy_community_step_template" "communitysteptemplate_octopus___check_targets_available" {
+  website = "https://library.octopus.com/step-templates/81444e7f-d77a-47db-b287-0f1ab5793880"
+}
+data "octopusdeploy_step_template" "steptemplate_octopus___check_targets_available" {
+  name = "Octopus - Check Targets Available"
+}
+resource "octopusdeploy_community_step_template" "communitysteptemplate_octopus___check_targets_available" {
+  community_action_template_id = "${data.octopusdeploy_community_step_template.communitysteptemplate_octopus___check_targets_available.steps[0].id}"
+  count                        = "${data.octopusdeploy_step_template.steptemplate_octopus___check_targets_available.step_template != null ? 0 : 1}"
+}
+
+data "octopusdeploy_community_step_template" "communitysteptemplate_octopus___check_smtp_server_configured" {
+  website = "https://library.octopus.com/step-templates/ad8126be-37af-4297-b46e-fce02ba3987a"
+}
+data "octopusdeploy_step_template" "steptemplate_octopus___check_smtp_server_configured" {
+  name = "Octopus - Check SMTP Server Configured"
+}
+resource "octopusdeploy_community_step_template" "communitysteptemplate_octopus___check_smtp_server_configured" {
+  community_action_template_id = "${data.octopusdeploy_community_step_template.communitysteptemplate_octopus___check_smtp_server_configured.steps[0].id}"
+  count                        = "${data.octopusdeploy_step_template.steptemplate_octopus___check_smtp_server_configured.step_template != null ? 0 : 1}"
+}
+
 resource "octopusdeploy_process" "process_random_quotes__net_iis" {
   count      = "${length(data.octopusdeploy_projects.project_random_quotes__net_iis.projects) != 0 ? 0 : 1}"
   project_id = "${length(data.octopusdeploy_projects.project_random_quotes__net_iis.projects) != 0 ? data.octopusdeploy_projects.project_random_quotes__net_iis.projects[0].id : octopusdeploy_project.project_random_quotes__net_iis[0].id}"
@@ -308,8 +330,8 @@ resource "octopusdeploy_process_step" "process_step_random_quotes__net_iis_appro
   properties            = {
       }
   execution_properties  = {
-        "Octopus.Action.Manual.BlockConcurrentDeployments" = "False"
         "Octopus.Action.Manual.Instructions" = "Do you approve the production deployment?"
+        "Octopus.Action.Manual.BlockConcurrentDeployments" = "False"
         "Octopus.Action.RunOnServer" = "true"
       }
 }
@@ -318,8 +340,8 @@ resource "octopusdeploy_process_templated_step" "process_step_random_quotes__net
   count                 = "${length(data.octopusdeploy_projects.project_random_quotes__net_iis.projects) != 0 ? 0 : 1}"
   name                  = "Octopus - Check Targets Available"
   process_id            = "${length(data.octopusdeploy_projects.project_random_quotes__net_iis.projects) != 0 ? null : octopusdeploy_process.process_random_quotes__net_iis[0].id}"
-  template_id           = ""
-  template_version      = ""
+  template_id           = "${data.octopusdeploy_step_template.steptemplate_octopus___check_targets_available.step_template != null ? data.octopusdeploy_step_template.steptemplate_octopus___check_targets_available.step_template.id : octopusdeploy_community_step_template.communitysteptemplate_octopus___check_targets_available[0].id}"
+  template_version      = "${data.octopusdeploy_step_template.steptemplate_octopus___check_targets_available.step_template != null ? data.octopusdeploy_step_template.steptemplate_octopus___check_targets_available.step_template.version : octopusdeploy_community_step_template.communitysteptemplate_octopus___check_targets_available[0].version}"
   channels              = null
   condition             = "Success"
   environments          = null
@@ -334,8 +356,8 @@ resource "octopusdeploy_process_templated_step" "process_step_random_quotes__net
       }
   execution_properties  = {
         "OctopusUseBundledTooling" = "False"
-        "Octopus.Action.Script.ScriptSource" = "Inline"
         "Octopus.Action.Script.Syntax" = "PowerShell"
+        "Octopus.Action.Script.ScriptSource" = "Inline"
         "Octopus.Action.RunOnServer" = "true"
         "Octopus.Action.Script.ScriptBody" = "$errorCollection = @()\n$setupValid = $false\n\nWrite-Host \"Checking for deployment targets ...\"\n\ntry\n{\n    # Check to make sure targets have been created\n    if ([string]::IsNullOrWhitespace(\"#{Octopus.Web.ServerUri}\"))\n    {\n        $octopusUrl = \"#{Octopus.Web.BaseUrl}\"\n    }\n    else\n    {\n        $octopusUrl = \"#{Octopus.Web.ServerUri}\"\n    }\n\n    $apiKey = \"#{CheckTargets.Octopus.Api.Key}\"\n    $role = \"#{CheckTargets.Octopus.Role}\"\n    $message = \"#{CheckTargets.Message}\"\n\n    if (![string]::IsNullOrWhitespace($apiKey) -and $apiKey.StartsWith(\"API-\"))\n    {\n        $spaceId = \"#{Octopus.Space.Id}\"\n        $headers = @{ \"X-Octopus-ApiKey\" = \"$apiKey\" }\n\n        try\n        {\n            $roleTargets = Invoke-RestMethod -Method Get -Uri \"$octopusUrl/api/$spaceId/machines?roles=$role\" -Headers $headers\n            if ($roleTargets.Items.Count -lt 1)\n            {\n                $errorCollection += @(\"Expected at least 1 target for tag $role, but found $( $roleTargets.Items.Count ). $message\")\n            }\n        }\n        catch\n        {\n            $errorCollection += @(\"Failed to retrieve role targets: $( $_.Exception.Message )\")\n        }\n\n        if ($errorCollection.Count -gt 0)\n        {\n            foreach ($item in $errorCollection)\n            {\n                Write-Highlight \"$item\"\n            }\n        }\n        else\n        {\n            $setupValid = $true\n            Write-Host \"Setup valid!\"\n        }\n    }\n    else\n    {\n        Write-Highlight \"The project variable CheckTargets.Octopus.Api.Key has not been configured, unable to check deployment targets.\"\n    }\n\n    Set-OctopusVariable -Name SetupValid -Value $setupValid\n} catch {\n    Write-Verbose \"Fatal error occurred:\"\n    Write-Verbose \"$($_.Exception.Message)\"\n}"
       }
@@ -345,8 +367,8 @@ resource "octopusdeploy_process_templated_step" "process_step_random_quotes__net
   count                 = "${length(data.octopusdeploy_projects.project_random_quotes__net_iis.projects) != 0 ? 0 : 1}"
   name                  = "Octopus - Check SMTP Server Configured"
   process_id            = "${length(data.octopusdeploy_projects.project_random_quotes__net_iis.projects) != 0 ? null : octopusdeploy_process.process_random_quotes__net_iis[0].id}"
-  template_id           = ""
-  template_version      = ""
+  template_id           = "${data.octopusdeploy_step_template.steptemplate_octopus___check_smtp_server_configured.step_template != null ? data.octopusdeploy_step_template.steptemplate_octopus___check_smtp_server_configured.step_template.id : octopusdeploy_community_step_template.communitysteptemplate_octopus___check_smtp_server_configured[0].id}"
+  template_version      = "${data.octopusdeploy_step_template.steptemplate_octopus___check_smtp_server_configured.step_template != null ? data.octopusdeploy_step_template.steptemplate_octopus___check_smtp_server_configured.step_template.version : octopusdeploy_community_step_template.communitysteptemplate_octopus___check_smtp_server_configured[0].version}"
   channels              = null
   condition             = "Success"
   environments          = null
@@ -360,10 +382,10 @@ resource "octopusdeploy_process_templated_step" "process_step_random_quotes__net
   properties            = {
       }
   execution_properties  = {
-        "Octopus.Action.Script.Syntax" = "PowerShell"
-        "Octopus.Action.Script.ScriptBody" = "$apiKey = \"#{SmtpCheck.Octopus.Api.Key}\"\n$isSmtpConfigured = $false\n\nif (![string]::IsNullOrWhitespace($apiKey) -and $apiKey.StartsWith(\"API-\"))\n{\n    if ([String]::IsNullOrWhitespace(\"#{Octopus.Web.ServerUri}\"))\n    {\n        $octopusUrl = \"#{Octopus.Web.BaseUrl}\"\n    }\n    else\n    {\n        $octopusUrl = \"#{Octopus.Web.ServerUri}\"\n    }\n\n    $uriBuilder = New-Object System.UriBuilder(\"$octopusUrl/api/smtpconfiguration/isconfigured\")\n    $uri = $uriBuilder.ToString()\n\n    try\n    {\n        $headers = @{ \"X-Octopus-ApiKey\" = $apiKey }\n        $smtpConfigured = Invoke-RestMethod -Method Get -Uri $uri -Headers $headers\n        $isSmtpConfigured = $smtpConfigured.IsConfigured\n    }\n    catch\n    {\n        Write-Host \"Error checking SMTP configuration: $($_.Exception.Message)\"\n    }\n}\nelse\n{\n    Write-Highlight \"The project variable SmtpCheck.Octopus.Api.Key has not been configured, unable to check SMTP configuration.\"\n}\n\nif (-not $isSmtpConfigured)\n{\n    Write-Highlight \"SMTP is not configured. Please [configure SMTP](https://octopus.com/docs/projects/built-in-step-templates/email-notifications#smtp-configuration) settings in Octopus Deploy.\"\n}\n\nSet-OctopusVariable -Name SmtpConfigured -Value $isSmtpConfigured"
         "Octopus.Action.RunOnServer" = "true"
         "OctopusUseBundledTooling" = "False"
+        "Octopus.Action.Script.Syntax" = "PowerShell"
+        "Octopus.Action.Script.ScriptBody" = "$apiKey = \"#{SmtpCheck.Octopus.Api.Key}\"\n$isSmtpConfigured = $false\n\nif (![string]::IsNullOrWhitespace($apiKey) -and $apiKey.StartsWith(\"API-\"))\n{\n    if ([String]::IsNullOrWhitespace(\"#{Octopus.Web.ServerUri}\"))\n    {\n        $octopusUrl = \"#{Octopus.Web.BaseUrl}\"\n    }\n    else\n    {\n        $octopusUrl = \"#{Octopus.Web.ServerUri}\"\n    }\n\n    $uriBuilder = New-Object System.UriBuilder(\"$octopusUrl/api/smtpconfiguration/isconfigured\")\n    $uri = $uriBuilder.ToString()\n\n    try\n    {\n        $headers = @{ \"X-Octopus-ApiKey\" = $apiKey }\n        $smtpConfigured = Invoke-RestMethod -Method Get -Uri $uri -Headers $headers\n        $isSmtpConfigured = $smtpConfigured.IsConfigured\n    }\n    catch\n    {\n        Write-Host \"Error checking SMTP configuration: $($_.Exception.Message)\"\n    }\n}\nelse\n{\n    Write-Highlight \"The project variable SmtpCheck.Octopus.Api.Key has not been configured, unable to check SMTP configuration.\"\n}\n\nif (-not $isSmtpConfigured)\n{\n    Write-Highlight \"SMTP is not configured. Please [configure SMTP](https://octopus.com/docs/projects/built-in-step-templates/email-notifications#smtp-configuration) settings in Octopus Deploy.\"\n}\n\nSet-OctopusVariable -Name SmtpConfigured -Value $isSmtpConfigured"
         "Octopus.Action.Script.ScriptSource" = "Inline"
       }
 }
diff --git a/domain/requests/github/copilot_request_context.py b/domain/requests/github/copilot_request_context.py
@@ -190,6 +190,9 @@
 from domain.tools.wrapper.projects.create_terraform_project import (
     create_terraform_project_wrapper,
 )
+from domain.tools.wrapper.projects.create_vm_bluegreen_project import (
+    create_vm_blue_green_project_wrapper,
+)
 from domain.tools.wrapper.projects.create_winservice_project import (
     create_winservice_project_wrapper,
 )
@@ -1373,6 +1376,33 @@ def build_form_tools(query, req: func.HttpRequest):
                     get_redirections_api_key(req),
                 ),
             ),
+            FunctionDefinition(
+                create_vm_blue_green_project_wrapper(
+                    query,
+                    callback=create_template_project_callback(
+                        lambda: get_api_key_and_url(req),
+                        get_github_user_from_form(req),
+                        get_functions_connection_string(),
+                        log_query,
+                        general_project_examples,
+                        "vmbluegreen.tf",
+                        "VM Blue/Green",
+                        "generalinstructions.txt",
+                        "vmbluegreensystemprompt.txt",
+                        get_redirections(req),
+                        get_redirections_api_key(req),
+                    ),
+                    logging=log_query,
+                ),
+                callback=create_template_project_confirm_callback_wrapper(
+                    query,
+                    get_github_user_from_form(req),
+                    lambda: get_api_key_and_url(req),
+                    log_query,
+                    get_redirections(req),
+                    get_redirections_api_key(req),
+                ),
+            ),
         ],
         fallback=FunctionDefinitions(docs_functions),
         invalid=FunctionDefinition(
diff --git a/domain/tools/wrapper/projects/create_vm_bluegreen_project.py b/domain/tools/wrapper/projects/create_vm_bluegreen_project.py
@@ -0,0 +1,38 @@
+def create_vm_blue_green_project_wrapper(query, callback, logging):
+    def create_vm_blue_green_project(
+        space_name=None,
+        project_name=None,
+        no_prompt=False,
+        **kwargs,
+    ):
+        """
+        Creates a Virtual Machine project with a blue-green deployment strategy in Octopus Deploy, in addition to any supporting resources.
+
+        Example prompts include:
+        * Create a VM Blue/Green project in the space "My Space" called "My Project"
+        * Create a VM project with the Blue/Green deployment strategy called "My Project" in the space "My Space"
+        * Create a VM Blue Green project called "My Project"
+
+        Args:
+        space_name: The name of the space
+        project_name: The name of the project
+        no_prompt: Weather to disable the prompt. Defaults to False.
+        """
+
+        if logging:
+            logging("Enter:", create_vm_blue_green_project.__name__)
+
+        for key, value in kwargs.items():
+            if logging:
+                logging(f"Unexpected Key: {key}", "Value: {value}")
+
+        # This is just a passthrough to the original callback
+        return callback(
+            create_vm_blue_green_project.__name__,
+            query,
+            space_name,
+            project_name,
+            no_prompt,
+        )
+
+    return create_vm_blue_green_project
diff --git a/infrastructure/octopus.py b/infrastructure/octopus.py
@@ -1222,6 +1222,23 @@ def get_space(space_id, api_key, octopus_url):
     return resp.json()
 
 
+@retry(HTTPError, tries=3, delay=2)
+@logging_wrapper
+def sync_community_step_templates(api_key, octopus_url):
+    base_url = f"api/tasks"
+    body = {
+        "Name": "SyncCommunityActionTemplates",
+        "Description": "Synchronize Community Step Templates",
+        "Arguments": {},
+        "SpaceId": None,
+    }
+    api, headers = build_url(octopus_url, api_key, base_url)
+    resp = handle_response(
+        lambda: http.request("POST", api, json=body, headers=headers)
+    )
+    return resp.json()
+
+
 @retry(HTTPError, tries=3, delay=2)
 @logging_wrapper
 def get_project(space_id, project_name, api_key, octopus_url):
diff --git a/tests/application/test_copilot_chat_create_projects.py b/tests/application/test_copilot_chat_create_projects.py
@@ -4,46 +4,32 @@
 import re
 import time
 import unittest
-import uuid
-from datetime import datetime
 
 import Levenshtein
 import azure.functions as func
 from openai import RateLimitError
-from requests.exceptions import HTTPError
+
 from retry import retry
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_for_logs
 
-from domain.lookup.octopus_lookups import (
-    lookup_space,
-    lookup_projects,
-    lookup_environments,
-    lookup_tenants,
-    lookup_runbooks,
-)
+
 from domain.transformers.sse_transformers import (
     convert_from_sse_response,
     get_confirmation_id,
 )
-from domain.url.session import create_session_blob
-from function_app import copilot_handler_internal, health_internal
+from function_app import copilot_handler_internal
 from infrastructure.octopus import (
-    run_published_runbook_fuzzy,
     get_space_id_and_name_from_name,
     get_project,
     get_runbook_fuzzy,
     get_raw_deployment_process,
     get_tenants,
+    sync_community_step_templates,
 )
 from infrastructure.terraform_context import save_terraform_context
 from infrastructure.users import save_users_octopus_url_from_login, save_default_values
-from tests.infrastructure.create_and_deploy_release import (
-    create_and_deploy_release,
-    wait_for_task,
-)
 from tests.infrastructure.octopus_config import Octopus_Api_Key, Octopus_Url
-from tests.infrastructure.publish_runbook import publish_runbook
 from tests.infrastructure.test_octopus_infrastructure import run_terraform
 
 
@@ -155,6 +141,8 @@ def setUpClass(cls):
                 cls.octopus, "Web server is ready to process requests", timeout=300
             )
 
+            sync_community_step_templates(Octopus_Api_Key, Octopus_Url)
+
             output = run_terraform(
                 terraform_dir + "simple/space_creation", Octopus_Url, Octopus_Api_Key
             )
@@ -261,6 +249,38 @@ def test_create_k8s_project_no_prompt(self):
             f"The following resources were created:" in response_text,
         )
 
+    @retry((AssertionError, RateLimitError), tries=3, delay=2)
+    def test_create_vm_blue_green_project(self):
+        project_name = "My VM Blue Green project"
+        prompt = f'Create a VM Blue/Green project called "{project_name}".'
+        response = copilot_handler_internal(build_request(prompt))
+        confirmation_id = get_confirmation_id(response.get_body().decode("utf8"))
+        self.assertTrue(confirmation_id != "", "Confirmation ID was " + confirmation_id)
+
+        confirmation = {
+            "messages": [
+                {
+                    "role": "user",
+                    "content": "",
+                    "copilot_references": None,
+                    "copilot_confirmations": [
+                        {"state": "accepted", "confirmation": {"id": confirmation_id}}
+                    ],
+                }
+            ]
+        }
+
+        run_response = copilot_handler_internal(
+            build_confirmation_request(confirmation)
+        )
+        response_text = convert_from_sse_response(
+            run_response.get_body().decode("utf8")
+        )
+        print(response_text)
+        self.assertTrue(
+            f"The following resources were created:" in response_text,
+        )
+
     @retry((AssertionError, RateLimitError), tries=2, delay=2)
     def test_create_azure_web_app_project(self):
         project_name = "My Azure WebApp Project"
