yast-rake 0.2.34 → 0.2.40

data/lib/tasks/github_actions/github_actions/job.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+module GithubActions
+  # Github Actions job
+  # @see https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+  class Job
+    attr_reader :name, :steps, :runs_on, :container, :workflow
+
+    # @param name [String] name of the job
+    # @param data [Hash] data from the workflow YAML file
+    # @param workflow [GithubActions::Workflow] the parent workflow
+    def initialize(name, data, workflow)
+      @name = name
+      @runs_on = data["runs-on"]
+      @container = data["container"]
+      @workflow = workflow
+
+      @steps = data["steps"].map do |step|
+        Step.new(self, step)
+      end
+    end
+
+    # check if the defined steps can be used locally
+    # @return [Array<String>] the list of unsupported steps, returns empty
+    #  list if all actions are supported
+    def unsupported_steps
+      steps.each_with_object([]) do |step, array|
+        array << step.name unless step.supported?
+      end
+    end
+  end
+end

data/lib/tasks/github_actions/github_actions/job_runner.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+module GithubActions
+  # Runs GitHub Actions job in a container locally
+  class JobRunner
+    include Colorizer
+
+    attr_reader :job, :image
+
+    # constructor
+    # @param job [GithubActions::Job] the job to run
+    # @param image [String,nil] override the Docker image to use,
+    #   if `nil` it by default uses the image specified in the job
+    def initialize(job, image = nil)
+      @job = job
+      @image = image
+    end
+
+    # run the job in a container
+    # @return [Boolean] `true` if all steps were successfully executed,
+    #  `false` otherwise
+    def run
+      stage("Running \"#{job.name}\" job from file #{job.workflow.file}")
+      start_container
+
+      result = true
+      job.steps.each do |step|
+        result &= run_step(step)
+      end
+
+      print_result(result)
+      container.stop
+      result
+    end
+
+  private
+
+    # GithubActions::Container
+    attr_reader :container
+
+    # pull the Docker image and start the container
+    def start_container
+      # prefer the custom image if requested
+      @container = Container.new(image || job.container)
+      container.pull
+      container.start
+    end
+
+    # run a job step
+    # @param step [GithubActions::Step] the step to run
+    # @return [Boolean] `true` if the step succeeded, `false` otherwise
+    def run_step(step)
+      info("Step \"#{step.name}\"")
+
+      # run "uses" step if present
+      run_uses_step(step.uses) if step.uses
+
+      # run "run" step if present
+      return true unless step.run
+
+      container.run(step.run)
+    end
+
+    # print the job result
+    # @param success [Boolean] status of the job
+    def print_result(success)
+      if success
+        success("Job result: SUCCESS")
+      else
+        error("Job result: FAILURE!")
+      end
+    end
+
+    # workarounds for some special Javascript actions which are otherwise
+    # not supported in general
+    # @param uses [String] name of the "uses" action
+    def run_uses_step(uses)
+      case uses
+      when CHECKOUT_ACTION
+        # emulate the Git checkout action, just copy the current checkout
+        # into the current directory in the running container
+        container.copy_current_dir
+      when COVERALLS_ACTION
+        # skip the coveralls action, do not send the code coverage report
+        # when running locally
+        info("Skipping the Coveralls step")
+      else
+        # this should actually never happen, we already checked for
+        # the unsupported steps before starting the job
+        raise "Unsupported action \"#{uses}\""
+      end
+    end
+  end
+end

data/lib/tasks/github_actions/github_actions/step.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+module GithubActions
+  # Github Actions step
+  # @see https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+  class Step
+    attr_reader :job, :name, :uses, :run, :env
+
+    # constructor
+    # @param job [GithubActions::Job] the parent job
+    # @param step [Hash] the step definition from the YAML file
+    def initialize(job, step)
+      @job = job
+      @name = step["name"]
+      @uses = step["uses"]
+      @run = step["run"]
+      @env = step["env"]
+    end
+
+    # we can run the step if it is just a plain command (not a Javascript or
+    # Docker container action) and the environment variables do not contain any
+    # expansions (usually used for Github secrets)
+    # @return [Boolean] `true` if the step is supported, `false` otherwise
+    def supported?
+      known_uses? && !expansion?
+    end
+
+  private
+
+    # Javascript or Docker actions are not supported
+    # @return [Boolean] `true` if there is a workaround defined for the step
+    def known_uses?
+      uses.nil? || uses.match?(CHECKOUT_ACTION) || uses.match?(COVERALLS_ACTION)
+    end
+
+    # we cannot expand the Github secrets
+    # @return [Boolean] `true` if an expansion is found, `false` otherwise
+    def expansion?
+      env&.any? { |_k, v| v.to_s.include?("${{") }
+    end
+  end
+end

data/lib/tasks/github_actions/github_actions/workflow.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+require "yaml"
+
+module GithubActions
+  # Github Actions workflow
+  # @see https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+  class Workflow
+    attr_reader :file, :name, :on, :jobs
+
+    # load all defined workflows from all YAML files
+    # @return [Array<GithubActions::Workflow>]
+    def self.read
+      Dir[".github/workflows/*.{yml,yaml}"].map do |file|
+        new(file)
+      end
+    end
+
+    # load the workflow from an YAML file
+    # @param file [String] path to the YAML file
+    def initialize(file)
+      @file = file
+      yml = YAML.load_file(file)
+      @name = yml["name"]
+      # "on" is autoconverted to Boolean "true" for this line
+      #   on: [push, pull_request]
+      # see https://medium.com/@lefloh/lessons-learned-about-yaml-and-norway-13ba26df680
+      @on = yml[true]
+
+      @jobs = yml["jobs"].map do |name, job|
+        Job.new(name, job, self)
+      end
+    end
+  end
+end

data/lib/tasks/github_actions/tasks.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+require_relative "tasks/details"
+require_relative "tasks/list"
+require_relative "tasks/run"
+require_relative "tasks/run_all"

data/lib/tasks/github_actions/tasks/details.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+require_relative "../github_actions"
+
+module GithubActions
+  module Tasks
+    # print the defined Github Actions jobs with details
+    class Details
+      include Colorizer
+
+      def run
+        Workflow.read.each_with_index do |workflow, index|
+          workflow.jobs.each do |job|
+            # empty line separator if multiple jobs are found
+            puts if index > 0
+
+            # print the job details
+            success(job.name)
+            puts "  run: \"rake actions:run[#{job.name}]\""
+            puts "  container: #{job.container}"
+            puts "  steps:"
+            job.steps.each do |step|
+              puts "    #{step.name}"
+              puts "      #{step.run}" if step.run
+              puts "      #{step.uses}" if step.uses
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/github_actions/tasks/list.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+require_relative "../github_actions"
+
+module GithubActions
+  module Tasks
+    # print the defined Github Actions jobs
+    class List
+      def run
+        Workflow.read.each do |workflow|
+          workflow.jobs.each do |job|
+            # print rake commands so users can easily copy&paste into terminal
+            puts "rake actions:run[#{job.name}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/github_actions/tasks/run.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2021 SUSE LLC
+#   This library is free software; you can redistribute it and/or modify
+# it only under the terms of version 2.1 of the GNU Lesser General Public
+# License as published by the Free Software Foundation.
+#
+#   This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+#++
+
+require_relative "../github_actions"
+
+module GithubActions
+  module Tasks
+    # run the requested Github Actions job locally
+    class Run
+      include Colorizer
+
+      # the requested job name
+      attr_reader :name
+
+      # constructor
+      # @param name [String] name of the job to run
+      def initialize(name)
+        @name = name
+      end
+
+      # run the GitHub Action locally
+      def run
+        runner = GithubActions::JobRunner.new(find_job, ENV["DOCKER_IMAGE"])
+        abort unless runner.run
+      end
+
+    private
+
+      # read the job definition from YAML file
+      def find_job
+        job = nil
+        Workflow.read.each do |workflow|
+          # Note: in theory the same job name might be used in different files,
+          # but in YaST we use single YAML files and we can avoid duplicates,
+          # simply use the first found and avoid unnecessary complexity
+          job = workflow.jobs.find { |j| j.name == name }
+        end
+
+        check_job(job)
+
+        job
+      end
+
+      # check if the job is valid and can be run locally,
+      # it aborts when the job cannot be used
+      def check_job(job)
+        if job.nil?
+          error("ERROR: Job \"#{name}\" not found")
+          abort
+        end
+
+        unsupported = job.unsupported_steps
+        if !unsupported.empty?
+          error("ERROR: These steps are not supported: #{unsupported.inspect}")
+          abort
+        end
+
+        return if job.container && !job.container.empty?
+
+        error("ERROR: Docker image name is missing in the job definition")
+        abort
+      end
+    end
+  end
+end