feat: [fme-8300]: Added functions to create Jira and Service Now tickets (#122)

* [fme-8300] Merge with master

* [fme-8300] Merge with master

* [fme-8300] Improving descriptions and removing unused parameters

* Merged with master

* [fme-8300] Merge with master

* [fme-8278] Removed refactor for code deduplication requested in PR review

* Merge branch 'master' into fme-8278_ccm_update_persp

* [fme-8300] Adding information to list jira projects and list jira issue types related functions

* [fme-8300] Added list Jira projects and List Jira issue types tools to get correct data for Jira Ticket creation

* [fme-8300] Added list Jira project tool to create a ticket for CCM Recomendations

* [fme-8278] Using slog library

* [fme-8300] Fixing some issues when creating Jira tickets

* [fme-8278] Merge with master

* [fme-8300] Handling Jira and Service Now differences

* Merge branch 'fme-8278_ccm_update_persp' into fme-8300_ccm_create_jira_4_recomm

* [fme-8278] Added destructive hint annotation to mutable tools

* [fme-8300] Adding default filter if nil to filter

Author: javrudsky

README.md

@@ -154,10 +154,19 @@ Toolset Name: `ccm`
 - `list_ccm_recommendations`: Returns a filterable list of cost-optimization recommendations in Harness Cloud Cost Management.
 - `list_ccm_recommendations_by_resource_type`: Returns a aggregated statistics of cloud cost optimization recommendations grouped by resource type within a given account in Harness Cloud Cost Management.
 - `get_ccm_recommendations_stats`: Returns overall statistics for cloud cost optimization recommendations within a given account in Harness Cloud Cost Management.
-- `update_ccm_recommendation_state`: Marks a recommendation as Applied/Open/Ignored in Harness Cloud Cost Management
-- `override_ccm_recommendation_savings`: Overrides savings for a recommendation in Harness Cloud Cost Management
-- `get_ccm_commitment_coverage`: Get commitment coverage information for an account in Harness Cloud Cost Management
-- `get_ccm_commitment_savings`: Get commitment savings information for an account in Harness Cloud Cost Management
+- `update_ccm_recommendation_state`: Marks a recommendation as Applied/Open/Ignored in Harness Cloud Cost Management.
+- `override_ccm_recommendation_savings`: Overrides savings for a recommendation in Harness Cloud Cost Management.
+- `create_jira_ticket_for_ccm_recommendation`: Creates a Jira ticket for a recommendation in Harness Cloud Cost Management.
+- `create_service_now_ticket_for_ccm_recommendation`: Creates a Service Now ticket for a recommendation in Harness Cloud Cost Management.
+- `get_ec2_recommendation_detail`: Returns ECS Recommendation details for the given Recommendation identifier.
+- `get_azure_vm_recommendation_detail`: Returns Azure Vm Recommendation details for the given Recommendation identifier.
+- `get_ecs_service_recommendation_detail`: Returns ECS Service Recommendation details for the given Recommendation identifier.
+- `get_node_pool_recommendation_detail`: Returns Node Pool Recommendation details for the given Recommendation identifier.
+- `get_workload_recommendation_detail`: Returns Workload Recommendation details for the given Recommendation identifier.
+- `list_jira_projects`: Returns a list of Jira projects available to create tickets for recommendations in Harness Cloud Cost Management.
+- `list_jira_issue_types`: Returns a list of Jira Issue types available to create tickets for recommendations in Harness Cloud Cost Management.
+- `get_ccm_commitment_coverage`: Get commitment coverage information for an account in Harness Cloud Cost Management.
+- `get_ccm_commitment_savings`: Get commitment savings information for an account in Harness Cloud Cost Management.
 - `get_ccm_commitment_utilisation`: Get commitment utilisation information for an account in Harness Cloud Cost Management broken down by Reserved Instances and Savings Plans in day wise granularity.
 - `get_ccm_estimated_savings`: Get estimated savings information for a cloud account in Harness Cloud Cost Management
 - `get_ccm_commitment_ec2_analysis`: Get AWS EC2 commitment analysis for an account in Harness Cloud Cost Management, including RI/SP commitment spend, utilization breakdown, current savings, estimated annualized savings, and ESR.

client/ccmrecommendations.go

@@ -3,43 +3,58 @@ package client
 import (
 	"context"
 	"fmt"
+	"log/slog"
 	"strconv"
 
 	"github.com/harness/harness-mcp/client/dto"
 )
 
 const (
-	ccmRecommendationsListPath               = ccmBasePath + "/recommendation/overview/list?accountIdentifier=%s"
-	ccmRecommendationsByResourceTypeListPath = ccmBasePath + "/recommendation/overview/resource-type/stats?accountIdentifier=%s"
-	ccmRecommendationsStatsPath              = ccmBasePath + "/recommendation/overview/stats?accountIdentifier=%s"
-	ccmUpdateRecommendationState             = ccmBasePath + "/recommendation/overview/change-state?accountIdentifier=%s"
-	ccmOverrideRecommendationSavings         = ccmBasePath + "/recommendation/overview/override-savings?accountIdentifier=%s"
+	ngBasePath                                  = "ng/api"
+	ccmRecommendationsListPath                  = ccmBasePath + "/recommendation/overview/list?accountIdentifier=%s"
+	ccmRecommendationsByResourceTypeListPath    = ccmBasePath + "/recommendation/overview/resource-type/stats?accountIdentifier=%s"
+	ccmRecommendationsStatsPath                 = ccmBasePath + "/recommendation/overview/stats?accountIdentifier=%s"
+	ccmUpdateRecommendationStatePath            = ccmBasePath + "/recommendation/overview/change-state?accountIdentifier=%s"
+	ccmOverrideRecommendationSavingsPath        = ccmBasePath + "/recommendation/overview/override-savings?accountIdentifier=%s"
+	ccmCreateRecommendationJiraTicketPath       = ccmBasePath + "/recommendation/jira/create?accountIdentifier=%s"
+	ccmCreateRecommendationServiceNowTicketPath = ccmBasePath + "/recommendation/servicenow/create?accountIdentifier=%s"
+	ccmGetRecommendationDetailPath              = ccmBasePath + "/recommendation/details/%s?accountIdentifier=%s&id=%s"
+	ccmTicketToolSettingsPath                   = ngBasePath + "/settings?accountIdentifier=%s&category=CE&group=ticketing_preferences"
+	ccmJiraProjectsPath                         = ngBasePath + "/jira/projects?accountIdentifier=%s&connectorRef=%s"
+	ccmJiraMetadataPath                         = ngBasePath + "/jira/createMetadata?accountIdentifier=%s"
 )
 
-func (r *CloudCostManagementService) ListRecommendations(ctx context.Context, scope dto.Scope, accountId string, options map[string]any) (*map[string]any, error) {
+const (
+	ec2Path        = "ec2-instance"
+	azureVmPath    = "azure-vm"
+	ecsServicePath = "ecs-service"
+	nodePoolPath   = "node-pool"
+	workloadPath   = "workload"
+)
 
-	return r.getRecommendations(ctx, scope, accountId, options, ccmRecommendationsListPath)
+func (r *CloudCostManagementService) ListRecommendations(ctx context.Context, accountId string, options map[string]any) (*map[string]any, error) {
+
+	return r.getRecommendations(ctx, accountId, options, ccmRecommendationsListPath)
 }
 
-func (r *CloudCostManagementService) ListRecommendationsByResourceType(ctx context.Context, scope dto.Scope, accountId string, options map[string]any) (*map[string]any, error) {
+func (r *CloudCostManagementService) ListRecommendationsByResourceType(ctx context.Context, accountId string, options map[string]any) (*map[string]any, error) {
 
-	return r.getRecommendations(ctx, scope, accountId, options, ccmRecommendationsByResourceTypeListPath)
+	return r.getRecommendations(ctx, accountId, options, ccmRecommendationsByResourceTypeListPath)
 }
 
-func (r *CloudCostManagementService) GetRecommendationsStats(ctx context.Context, scope dto.Scope, accountId string, options map[string]any) (*map[string]any, error) {
+func (r *CloudCostManagementService) GetRecommendationsStats(ctx context.Context, accountId string, options map[string]any) (*map[string]any, error) {
 
-	return r.getRecommendations(ctx, scope, accountId, options, ccmRecommendationsStatsPath)
+	return r.getRecommendations(ctx, accountId, options, ccmRecommendationsStatsPath)
 }
 
 func (r *CloudCostManagementService) UpdateRecommendationState(
 	ctx context.Context,
-	scope dto.Scope,
 	accountId string,
 	recommendationId string,
 	state string,
 ) (*map[string]any, error) {
 
-	path := fmt.Sprintf(ccmUpdateRecommendationState, accountId)
+	path := fmt.Sprintf(ccmUpdateRecommendationStatePath, accountId)
 	params := make(map[string]string)
 	params["recommendationId"] = recommendationId
 	params["state"] = state
@@ -56,13 +71,11 @@ func (r *CloudCostManagementService) UpdateRecommendationState(
 
 func (r *CloudCostManagementService) OverrideRecommendationSavings(
 	ctx context.Context,
-	scope dto.Scope,
 	accountId string,
 	recommendationId string,
 	savings float64,
 ) (*map[string]any, error) {
-
-	path := fmt.Sprintf(ccmOverrideRecommendationSavings, accountId)
+	path := fmt.Sprintf(ccmOverrideRecommendationSavingsPath, accountId)
 	params := make(map[string]string)
 	params["recommendationId"] = recommendationId
 	params["overriddenSavings"] = strconv.FormatFloat(savings, 'f', -1, 64)
@@ -79,15 +92,13 @@ func (r *CloudCostManagementService) OverrideRecommendationSavings(
 
 func (r *CloudCostManagementService) getRecommendations(
 	ctx context.Context,
-	scope dto.Scope,
 	accountId string,
 	options map[string]any,
 	url string,
 ) (*map[string]any, error) {
 
 	path := fmt.Sprintf(url, accountId)
 	params := make(map[string]string)
-	addScope(scope, params)
 
 	items := new(map[string]any)
 
@@ -98,3 +109,196 @@ func (r *CloudCostManagementService) getRecommendations(
 
 	return items, nil
 }
+
+func (r *CloudCostManagementService) CreateJiraTicket(
+	ctx context.Context,
+	accountId string,
+	ticketDetails dto.CCMTicketDetails,
+) (*map[string]any, error) {
+
+	url := fmt.Sprintf(ccmCreateRecommendationJiraTicketPath, accountId) // Define ccmCreateJiraIssue as needed
+	return r.createTicket(ctx, accountId, ticketDetails, url)
+}
+
+func (r *CloudCostManagementService) CreateServiceNowTicket(
+	ctx context.Context,
+	accountId string,
+	ticketDetails dto.CCMTicketDetails,
+) (*map[string]any, error) {
+
+	url := fmt.Sprintf(ccmCreateRecommendationServiceNowTicketPath, accountId) // Define ccmCreateJiraIssue as needed
+	return r.createTicket(ctx, accountId, ticketDetails, url)
+}
+
+func (r *CloudCostManagementService) createTicket(
+	ctx context.Context,
+	accountId string,
+	ticketDetails dto.CCMTicketDetails,
+	url string,
+) (*map[string]any, error) {
+
+	// Fist check if ticketing tool is available from settings
+	platform, err := r.getTicketingToolSettings(ctx, accountId)
+
+	if err != nil {
+		return nil, fmt.Errorf("Failed to get ticket tool settings in cloud cost management recommendations: %w", err)
+	}
+
+	if platform != ticketDetails.Platform {
+		return nil, fmt.Errorf("Ticketing tool not available for this account: %s", ticketDetails.Platform)
+	}
+
+	body := map[string]any{
+		"recommendationId": ticketDetails.RecommendationId,
+		"resourceType":     ticketDetails.ResourceType,
+		"connectorRef":     ticketDetails.ConnectorRef,
+		"fields":           ticketDetails.Fields,
+	}
+
+	if ticketDetails.Platform == dto.TicketPlatformJira {
+		body["projectKey"] = ticketDetails.ProjectKey
+		body["issueType"] = ticketDetails.TicketType
+	} else {
+		body["ticketType"] = ticketDetails.TicketType
+	}
+
+	slog.Debug("Creating CCM Ticket", "accountId", accountId, "jiraDetails", body, "ticketType", ticketDetails.TicketType)
+
+	resp := new(map[string]any)
+
+	err = r.Client.Post(ctx, url, nil, body, map[string]string{}, &resp)
+	if err != nil {
+		return nil, fmt.Errorf("Failed to create CCM Jira issue: %w", err)
+	}
+
+	return resp, nil
+}
+
+func (r *CloudCostManagementService) GetEc2RecommendationDetail(ctx context.Context, options dto.CCMRecommendationDetailOptions) (*map[string]any, error) {
+	return r.getRecommendationDetail(ctx, options, ec2Path)
+}
+
+func (r *CloudCostManagementService) GetAzureVmRecommendationDetail(ctx context.Context, options dto.CCMRecommendationDetailOptions) (*map[string]any, error) {
+	return r.getRecommendationDetail(ctx, options, azureVmPath)
+}
+
+func (r *CloudCostManagementService) GetEcsServiceRecommendationDetail(ctx context.Context, options dto.CCMRecommendationDetailOptions) (*map[string]any, error) {
+	return r.getRecommendationDetail(ctx, options, ecsServicePath)
+}
+
+func (r *CloudCostManagementService) GetNodePoolRecommendationDetail(ctx context.Context, options dto.CCMRecommendationDetailOptions) (*map[string]any, error) {
+	return r.getRecommendationDetail(ctx, options, nodePoolPath)
+}
+
+func (r *CloudCostManagementService) GetWorkloadRecommendationDetail(ctx context.Context, options dto.CCMRecommendationDetailOptions) (*map[string]any, error) {
+	return r.getRecommendationDetail(ctx, options, workloadPath)
+}
+
+func (r *CloudCostManagementService) ListJiraProjects(
+	ctx context.Context,
+	accountId string,
+	connector string,
+) (*map[string]any, error) {
+
+	path := fmt.Sprintf(ccmJiraProjectsPath, accountId, connector)
+
+	items := new(map[string]any)
+
+	err := r.Client.Get(ctx, path, nil, nil, &items)
+	if err != nil {
+		return nil, fmt.Errorf("Failed to list Jira Projects: %w", err)
+	}
+
+	return items, nil
+}
+
+func (r *CloudCostManagementService) ListJiraIssueTypes(
+	ctx context.Context,
+	options dto.CCMJiraIssueTypesOptions,
+) (*dto.CCMJiraIssueTypesList, error) {
+
+	path := fmt.Sprintf(ccmJiraMetadataPath, options.AccountId)
+
+	params := map[string]string{
+		"connectorRef": options.ConnectorRef,
+		"projectKey":   options.ProjectKey,
+	}
+
+	resp := new(dto.CCMJiraIssueTypesResponse)
+	err := r.Client.Get(ctx, path, params, nil, &resp)
+	if err != nil {
+		return nil, fmt.Errorf("Failed to list Jira Issue Types: %w", err)
+	}
+	slog.Debug("Jira Issue Types Response", "response", resp)
+	items := ExtractIssueTypesList(*resp)
+	slog.Debug("Jira Issue Types Response", "items", items)
+	return &items, nil
+}
+
+func (r *CloudCostManagementService) getRecommendationDetail(
+	ctx context.Context,
+	options dto.CCMRecommendationDetailOptions,
+	typePath string,
+) (*map[string]any, error) {
+
+	path := fmt.Sprintf(ccmGetRecommendationDetailPath, typePath, options.AccountIdentifier, options.RecommendationId)
+	params := make(map[string]string)
+
+	if typePath == ecsServicePath || typePath == workloadPath {
+		params["from"] = options.From
+		params["to"] = options.To
+	}
+
+	if typePath == ecsServicePath {
+		params["bufferPercentage"] = strconv.FormatInt(options.BufferPercentage, 10)
+	}
+
+	items := new(map[string]any)
+
+	err := r.Client.Get(ctx, path, params, nil, &items)
+
+	if err != nil {
+		return nil, fmt.Errorf("Failed to list cloud cost management recommendations: %w", err)
+	}
+
+	return items, nil
+}
+
+// Returns dto.TicketPlatformJira or dto.TicketPlatformServiceNow based on the settings
+func (r *CloudCostManagementService) getTicketingToolSettings(
+	ctx context.Context,
+	accountId string,
+) (string, error) {
+
+	path := fmt.Sprintf(ccmTicketToolSettingsPath, accountId)
+
+	resp := new(dto.CCMTicketToolSettingsResponse)
+	err := r.Client.Get(ctx, path, nil, nil, &resp)
+	if err != nil {
+		return "", fmt.Errorf("Failed to get ticket tool settings in cloud cost management recommendations: %w", err)
+	}
+
+	return ExtractTicketingToolValue(*resp)
+}
+
+func ExtractTicketingToolValue(resp dto.CCMTicketToolSettingsResponse) (string, error) {
+	for _, d := range resp.Data {
+		if d.Setting.Identifier == "ticketing_tool" {
+			slog.Debug("Current ticketing tool setting", "setting", d.Setting.Value)
+			return d.Setting.Value, nil
+		}
+	}
+
+	slog.Debug("Current ticketing tool setting not found")
+	return "", fmt.Errorf("ticketing_tool setting not found")
+}
+
+func ExtractIssueTypesList(resp dto.CCMJiraIssueTypesResponse) dto.CCMJiraIssueTypesList {
+	var issueTypes []dto.CCMJiraIssueType
+	for _, project := range resp.Data.Projects {
+		for _, issueType := range project.IssueTypes {
+			issueTypes = append(issueTypes, issueType)
+		}
+	}
+	return dto.CCMJiraIssueTypesList{CCMBaseResponse: resp.CCMBaseResponse, Data: issueTypes}
+}