fastlane-plugin-circle_ci 0.2.0 → 0.3.0

data/lib/fastlane/plugin/circle_ci/actions/circleci_get_project_workflow_metrics.rb

@@ -0,0 +1,121 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_PROJECT_WORKFLOW_METRICS = :CIRCLECI_PROJECT_WORKFLOW_METRICS
+    end
+
+    class CircleciGetProjectWorkflowMetricsAction < Action
+      def self.run(params)
+        UI.message("Getting workflow metrics for CircleCI project via Insights API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        
+        # Build query parameters
+        query_params = {}
+        query_params["branch"] = params[:branch] if params[:branch]
+        query_params["reporting-window"] = params[:reporting_window] if params[:reporting_window]
+        query_params["workflow-name"] = params[:workflow_name] if params[:workflow_name]
+        query_params["page-token"] = params[:page_token] if params[:page_token]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/#{project_slug}/workflows", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_PROJECT_WORKFLOW_METRICS] = result
+        
+        UI.success("Successfully retrieved workflow metrics for project #{project_slug}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets summary metrics for a project's workflows using Insights API v2"
+      end
+
+      def self.details
+        "This action retrieves summary metrics for a project's workflows using the CircleCI Insights API v2. Workflow runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "CIRCLE_CI_PROJECT_SLUG",
+                                       description: "Project slug in the form of :vcs-type/:org-name/:project-name (e.g. github/myorg/myrepo)",
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_PROJECT_SLUG"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                       description: "The name of a branch to filter for",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :reporting_window,
+                                       description: "The time window used to calculate summary metrics (last-24-hours, last-7-days, last-90-days, etc.)",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :workflow_name,
+                                       description: "The name of a workflow to filter for",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :page_token,
+                                       description: "A token to retrieve the next page of results",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_PROJECT_WORKFLOW_METRICS', 'A hash containing workflow metrics for the project']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing workflow metrics for the project."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_project_workflow_metrics(
+            project_slug: "gh/MyOrg/my-project"
+          )',
+          'metrics = circleci_get_project_workflow_metrics(
+            project_slug: "gh/MyOrg/my-project",
+            branch: "main",
+            reporting_window: "last-30-days"
+          )
+          
+          # Access the workflow metrics
+          metrics["items"].each do |workflow|
+            UI.message("Workflow: #{workflow["name"]}, Success Rate: #{workflow["success_rate"]}")
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_get_trigger.rb

@@ -0,0 +1,99 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_TRIGGER_INFO = :CIRCLECI_TRIGGER_INFO
+    end
+
+    class CircleciGetTriggerAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI trigger information via API v2...")
+        
+        api_token = params[:api_token]
+        project_id = params[:project_id]
+        trigger_id = params[:trigger_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("projects/#{project_id}/triggers/#{trigger_id}", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_TRIGGER_INFO] = result
+        
+        UI.success("Successfully retrieved trigger information")
+        
+        return result
+      end
+
+      def self.description
+        "Gets information about a specific trigger using CircleCI API v2"
+      end
+
+      def self.details
+        "This action retrieves detailed information about a specific trigger using the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "CIRCLE_CI_PROJECT_ID",
+                                       description: "The ID of the CircleCI project",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :trigger_id,
+                                       description: "The ID of the trigger to retrieve",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_TRIGGER_INFO', 'A hash containing the trigger information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing detailed information about the trigger."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_trigger(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            trigger_id: "fedcba98-7654-3210-fedc-ba9876543210"
+          )',
+          'trigger_info = circleci_get_trigger(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            trigger_id: "fedcba98-7654-3210-fedc-ba9876543210"
+          )
+          
+          # Use the trigger information
+          UI.message("Trigger type: #{trigger_info["type"]}, Description: #{trigger_info["description"]}")'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_get_user_info.rb

@@ -0,0 +1,83 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_USER_INFO = :CIRCLECI_USER_INFO
+    end
+
+    class CircleciGetUserInfoAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI user information via API v2...")
+        
+        api_token = params[:api_token]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("me", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_USER_INFO] = result
+        
+        UI.success("Successfully retrieved user information for #{result["name"] || result["login"]}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets information about the authenticated CircleCI user using API v2"
+      end
+
+      def self.details
+        "This action retrieves information about the currently authenticated CircleCI user using the CircleCI API v2. This includes details such as name, login, and ID."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_USER_INFO', 'A hash containing the user information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing user information including name, login, and ID."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_user_info',
+          'user_info = circleci_get_user_info
+          
+          # Display user details
+          puts "User: #{user_info["name"] || user_info["login"]}"
+          puts "ID: #{user_info["id"]}"'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow.rb

@@ -0,0 +1,121 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WORKFLOW = :CIRCLECI_WORKFLOW
+    end
+
+    class CircleciGetWorkflowAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI workflow via API v2...")
+        
+        api_token = params[:api_token]
+        workflow_id = params[:workflow_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("workflow/#{workflow_id}", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_WORKFLOW] = result
+        
+        UI.success("Successfully retrieved workflow #{workflow_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets information about a CircleCI workflow using API v2"
+      end
+
+      def self.details
+        "This action retrieves detailed information about a specific CircleCI workflow using the CircleCI API v2, including status, created timestamp, pipeline ID, and project data."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :workflow_id,
+                                       env_name: "CIRCLE_CI_WORKFLOW_ID",
+                                       description: "The ID of the workflow to get information for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WORKFLOW', 'A hash containing the workflow details']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing detailed workflow information including status, created timestamp, and pipeline ID."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_workflow(
+            workflow_id: "workflow-uuid"
+          )',
+          'workflow = circleci_get_workflow(
+            workflow_id: "workflow-uuid"
+          )
+          
+          # Print workflow details
+          puts "Workflow name: #{workflow["name"]}"
+          puts "Status: #{workflow["status"]}"
+          puts "Created at: #{workflow["created_at"]}"
+          
+          case workflow["status"]
+          when "success"
+            UI.success("Workflow completed successfully")
+          when "running"
+            UI.important("Workflow is still running")
+            
+            # Get workflow jobs
+            jobs = circleci_get_workflow_jobs(
+              workflow_id: workflow["id"]
+            )
+            
+            running_jobs = jobs.select { |j| j["status"] == "running" }
+            UI.message("There are #{running_jobs.count} jobs still running")
+          when "failed"
+            UI.error("Workflow failed")
+            
+            # Get workflow jobs to find failure
+            jobs = circleci_get_workflow_jobs(
+              workflow_id: workflow["id"]
+            )
+            
+            failed_jobs = jobs.select { |j| j["status"] == "failed" }
+            failed_jobs.each do |job|
+              UI.error("Job #{job["name"]} failed")
+            end
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow_insights.rb

@@ -0,0 +1,157 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WORKFLOW_INSIGHTS = :CIRCLECI_WORKFLOW_INSIGHTS
+    end
+
+    class CircleciGetWorkflowInsightsAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI workflow insights via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        workflow_name = params[:workflow_name]
+        
+        # Construct query parameters
+        query_params = []
+        
+        # Add optional parameters if provided
+        query_params << "branches=#{params[:branches].join(',')}" if params[:branches]
+        query_params << "branch=#{params[:branch]}" if params[:branch]
+        query_params << "start-date=#{params[:start_date]}" if params[:start_date]
+        query_params << "end-date=#{params[:end_date]}" if params[:end_date]
+        
+        # Construct the query string
+        query_string = query_params.empty? ? "" : "?#{query_params.join('&')}"
+        
+        # Make API request
+        endpoint = "insights/#{project_slug}/workflows/#{workflow_name}#{query_string}"
+        result = Helper::CircleCiHelper.get_v2(endpoint, api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_WORKFLOW_INSIGHTS] = result
+        
+        UI.success("Successfully retrieved workflow insights for #{workflow_name}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets workflow insights data from CircleCI using API v2"
+      end
+
+      def self.details
+        "This action retrieves detailed insights and metrics for a specific workflow in a project using the CircleCI API v2. " +
+        "The data includes success rates, duration metrics, and historical trends for the specified workflow."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "CIRCLE_CI_PROJECT_SLUG",
+                                       description: "Project slug in the form of :vcs-type/:org-name/:project-name (e.g. github/myorg/myrepo)",
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_PROJECT_SLUG"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :workflow_name,
+                                       env_name: "CIRCLE_CI_WORKFLOW_NAME",
+                                       description: "The name of the workflow to get insights for",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :branches,
+                                       env_name: "CIRCLE_CI_BRANCHES",
+                                       description: "The names of branches to include in the results (array)",
+                                       is_string: false,
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                       env_name: "CIRCLE_CI_BRANCH",
+                                       description: "The name of a specific branch to filter results",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :start_date,
+                                       env_name: "CIRCLE_CI_START_DATE",
+                                       description: "The start date for the report in YYYY-MM-DD format",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :end_date,
+                                       env_name: "CIRCLE_CI_END_DATE",
+                                       description: "The end date for the report in YYYY-MM-DD format",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WORKFLOW_INSIGHTS', 'A hash containing the workflow insights data']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing workflow insights data including metrics, durations, and trends."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_workflow_insights(
+            project_slug: "github/myorg/myrepo",
+            workflow_name: "build-test-deploy"
+          )',
+          '# Get workflow insights for a specific date range and branch
+          insights = circleci_get_workflow_insights(
+            project_slug: "github/myorg/myrepo",
+            workflow_name: "build-test-deploy",
+            branch: "main",
+            start_date: "2023-01-01",
+            end_date: "2023-01-31"
+          )
+          
+          # Analyze insights data
+          success_rate = insights["success_rate"]
+          median_duration_secs = insights["metrics"]["duration_metrics"]["median"]
+          total_runs = insights["metrics"]["total_runs"]
+          
+          # Report findings
+          UI.message("Workflow success rate: #{success_rate}%")
+          UI.message("Median duration: #{median_duration_secs / 60.0} minutes")
+          UI.message("Total runs: #{total_runs}")
+          
+          # Look for duration trends
+          if insights["trends"] && insights["trends"]["duration_trend"] > 0
+            UI.important("⚠️ Build times are trending upward!")
+          elsif insights["trends"] && insights["trends"]["duration_trend"] < 0
+            UI.success("✅ Build times are trending downward!")
+          else
+            UI.message("Build times are stable")
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end