fastlane-plugin-circle_ci 0.2.0 → 0.3.0

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

@@ -0,0 +1,114 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_CONTEXT_ENV_VARS = :CIRCLECI_CONTEXT_ENV_VARS
+    end
+
+    class CircleciGetContextEnvVarsAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI context environment variables via API v2...")
+        
+        api_token = params[:api_token]
+        context_id = params[:context_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("context/#{context_id}/environment-variable", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_CONTEXT_ENV_VARS] = result["items"]
+        
+        UI.success("Successfully retrieved #{result["items"].count} environment variables for context #{context_id}")
+        
+        return result["items"]
+      end
+
+      def self.description
+        "Gets environment variables for a CircleCI context using API v2"
+      end
+
+      def self.details
+        "This action retrieves all environment variables for a specific CircleCI context using the CircleCI API v2. For security reasons, values are not returned, only variable names."
+      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: :context_id,
+                                       env_name: "CIRCLE_CI_CONTEXT_ID",
+                                       description: "The ID of the context to get environment variables for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_CONTEXT_ENV_VARS', 'An array of environment variable names for the context']
+        ]
+      end
+
+      def self.return_value
+        "Returns an array of environment variable data. For security reasons, only variable names are provided, not values."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_context_env_vars(
+            context_id: "context-uuid"
+          )',
+          '# First get all contexts, then find a specific one and its environment variables
+          contexts = circleci_list_contexts(
+            owner_slug: "github/myorg"
+          )
+          
+          # Find the production context
+          prod_context = contexts.find { |c| c["name"] == "production" }
+          
+          if prod_context
+            # Get all environment variables in the production context
+            env_vars = circleci_get_context_env_vars(
+              context_id: prod_context["id"]
+            )
+            
+            # Check if a specific variable exists
+            if env_vars.any? { |var| var["variable"] == "API_KEY" }
+              UI.success("API_KEY is set in the production context")
+            else
+              UI.important("API_KEY is missing from the production context")
+              
+              # Add the missing variable
+              circleci_add_context_env_var(
+                context_id: prod_context["id"],
+                env_var_name: "API_KEY",
+                env_var_value: "secret-api-key-value"
+              )
+            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_env_vars.rb

@@ -0,0 +1,95 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_ENV_VARS = :CIRCLECI_ENV_VARS
+    end
+
+    class CircleciGetEnvVarsAction < Action
+      def self.run(params)
+        UI.message("Getting environment variables for CircleCI project via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("project/#{project_slug}/envvar", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_ENV_VARS] = result["items"]
+        
+        UI.success("Successfully retrieved #{result["items"].count} environment variables for project #{project_slug}")
+        
+        return result["items"]
+      end
+
+      def self.description
+        "Gets environment variables for a CircleCI project using API v2"
+      end
+
+      def self.details
+        "This action retrieves all environment variables for a specific CircleCI project using the CircleCI API v2. Note that values are not included in the response for security reasons."
+      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)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_ENV_VARS', 'An array of environment variable data for the project']
+        ]
+      end
+
+      def self.return_value
+        "Returns an array of environment variable data including names."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_env_vars(
+            project_slug: "github/myorg/myrepo"
+          )',
+          'env_vars = circleci_get_env_vars(
+            project_slug: "github/myorg/myrepo"
+          )
+          
+          # Check if a specific environment variable exists
+          has_api_key = env_vars.any? { |var| var["name"] == "API_KEY" }
+          puts "API key is #{has_api_key ? "set" : "not set"} for this project"'
+        ]
+      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_flaky_tests.rb

@@ -0,0 +1,99 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_FLAKY_TESTS = :CIRCLECI_FLAKY_TESTS
+    end
+
+    class CircleciGetFlakyTestsAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI flaky tests via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/#{project_slug}/flaky-tests", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_FLAKY_TESTS] = result
+        
+        UI.success("Successfully retrieved flaky tests data for #{project_slug}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets flaky tests information for a CircleCI project using API v2"
+      end
+
+      def self.details
+        "This action retrieves information about flaky tests for a specific CircleCI project using the CircleCI API v2. This is useful for monitoring test health and improving CI reliability."
+      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)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_FLAKY_TESTS', 'A hash containing flaky tests information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing flaky tests information including average test count, most failed tests, and slowest tests."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_flaky_tests(
+            project_slug: "gh/MyOrg/my-project"
+          )',
+          'flaky_tests = circleci_get_flaky_tests(
+            project_slug: "gh/MyOrg/my-project"
+          )
+          
+          # Take action based on flaky tests
+          if flaky_tests["most_failed_tests"].any?
+            UI.important("Found #{flaky_tests["most_failed_tests"].count} flaky tests that need attention")
+            flaky_tests["most_failed_tests"].each do |test|
+              puts "  - #{test["test_name"]}: Failed #{test["times_flaked"]} times"
+            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_job_artifacts.rb

@@ -0,0 +1,111 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_JOB_ARTIFACTS = :CIRCLECI_JOB_ARTIFACTS
+    end
+
+    class CircleciGetJobArtifactsAction < Action
+      def self.run(params)
+        UI.message("Getting artifacts for CircleCI job via API v2...")
+        
+        api_token = params[:api_token]
+        job_number = params[:job_number]
+        project_slug = params[:project_slug]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("project/#{project_slug}/job/#{job_number}/artifacts", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_JOB_ARTIFACTS] = result["items"]
+        
+        UI.success("Successfully retrieved #{result["items"].count} artifacts for job #{job_number}")
+        
+        return result["items"]
+      end
+
+      def self.description
+        "Gets artifacts for a CircleCI job using API v2"
+      end
+
+      def self.details
+        "This action retrieves all artifacts generated by a specific CircleCI job 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_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: :job_number,
+                                       env_name: "CIRCLE_CI_JOB_NUMBER",
+                                       description: "The number of the job to get artifacts for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_JOB_ARTIFACTS', 'An array of artifact data for the job']
+        ]
+      end
+
+      def self.return_value
+        "Returns an array of artifact data including URLs, paths, and node information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_job_artifacts(
+            project_slug: "github/myorg/myrepo",
+            job_number: "123"
+          )',
+          'artifacts = circleci_get_job_artifacts(
+            project_slug: "github/myorg/myrepo",
+            job_number: "123"
+          )
+          
+          # Find and download a specific artifact
+          if artifacts.any?
+            test_results = artifacts.find { |a| a["path"].end_with?("test-results.xml") }
+            
+            if test_results
+              circleci_download_artifact(
+                artifact_url: test_results["url"],
+                destination_path: "./test-results/circle-results.xml"
+              )
+            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_job_details.rb

@@ -0,0 +1,110 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_JOB_DETAILS = :CIRCLECI_JOB_DETAILS
+    end
+
+    class CircleciGetJobDetailsAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI job details via API v2...")
+        
+        api_token = params[:api_token]
+        job_number = params[:job_number]
+        project_slug = params[:project_slug]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("project/#{project_slug}/job/#{job_number}", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_JOB_DETAILS] = result
+        
+        UI.success("Successfully retrieved job details for job #{job_number}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets detailed information about a CircleCI job using API v2"
+      end
+
+      def self.details
+        "This action retrieves detailed information about a specific CircleCI job using the CircleCI API v2, including status, duration, and executor information."
+      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: :job_number,
+                                       env_name: "CIRCLE_CI_JOB_NUMBER",
+                                       description: "The number of the job to get details for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_JOB_DETAILS', 'A hash containing the job details']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing detailed job information including status, duration, and executor information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_job_details(
+            project_slug: "github/myorg/myrepo",
+            job_number: "123"
+          )',
+          'job_details = circleci_get_job_details(
+            project_slug: "github/myorg/myrepo",
+            job_number: "123"
+          )
+          
+          if job_details["status"] == "success"
+            duration_seconds = job_details["duration"]
+            puts "Job completed successfully in #{duration_seconds} seconds"
+            
+            # Calculate job cost
+            credits_per_minute = 7 # Example value, depends on your plan and resource class
+            minutes = (duration_seconds / 60.0).ceil
+            cost = minutes * credits_per_minute
+            puts "Estimated job cost: #{cost} credits"
+          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_job_tests.rb

@@ -0,0 +1,111 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_JOB_TESTS = :CIRCLECI_JOB_TESTS
+    end
+
+    class CircleciGetJobTestsAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI job test results via API v2...")
+        
+        api_token = params[:api_token]
+        job_number = params[:job_number]
+        project_slug = params[:project_slug]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("project/#{project_slug}/#{job_number}/tests", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_JOB_TESTS] = result
+        
+        UI.success("Successfully retrieved test results for job #{job_number}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets test metadata for a CircleCI job using API v2"
+      end
+
+      def self.details
+        "This action retrieves test metadata for a specific CircleCI job using the CircleCI API v2. It returns detailed information about tests that were run as part of the job, including test names, classnames, results, and durations."
+      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/repo-name (e.g. github/myorg/myrepo)",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :job_number,
+                                       env_name: "CIRCLE_CI_JOB_NUMBER",
+                                       description: "The number of the job to get test results for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_JOB_TESTS', 'A hash containing the job test results']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing detailed test results information including test names, classnames, results, and durations."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_job_tests(
+            project_slug: "github/myorg/myrepo",
+            job_number: "123"
+          )',
+          'test_results = circleci_get_job_tests(
+            project_slug: "github/myorg/myrepo",
+            job_number: "123"
+          )
+          
+          # Count failing tests
+          failing_tests = test_results["items"].select { |test| test["result"] == "failure" }
+          UI.message("#{failing_tests.count} failing tests found")
+          
+          # Print details of failing tests
+          failing_tests.each do |test|
+            UI.error("Failed: #{test["classname"]}##{test["name"]} (#{test["file"] || "unknown file"})")
+            UI.error("Message: #{test["message"]}") if test["message"]
+          end
+          
+          # Calculate total test duration
+          total_duration_ms = test_results["items"].sum { |test| test["run_time"] || 0 }
+          UI.message("Total test duration: #{total_duration_ms / 1000.0} seconds")'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end