yast-rake 0.2.36 → 0.2.41

data/lib/tasks/github_actions/tasks/run_all.rb

@@ -0,0 +1,111 @@
+# 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 all supported Github Action jobs locally
+    class RunAll
+      include Colorizer
+
+      # run all jobs one by one, continue even if a job fails,
+      # print the summary in the end
+      def run
+        # collect failed jobs
+        failed_jobs = []
+        workflows = Workflow.read
+        # custom Docker image requested?
+        image = custom_image(workflows)
+
+        workflows.each do |workflow|
+          workflow.jobs.each do |job|
+            # skip unsupported jobs
+            next unless valid_job?(job)
+
+            runner = JobRunner.new(job, image)
+            failed_jobs << job.name if !runner.run
+          end
+        end
+
+        print_result(failed_jobs)
+      end
+
+    private
+
+      # check if a custom image can be used for all jobs,
+      # if more than one Docker image is used than it's unlikely that
+      # a same custom image will work for all jobs, rather abort in that case
+      # to avoid some strange errors when using incorrect image
+      # @param workflows [GithubActions::Workflow] all defined workflows
+      # @return [String,nil] the custom Docker image name or `nil` if not specified
+      def custom_image(workflows)
+        return nil unless ENV["DOCKER_IMAGE"]
+
+        images = workflows.each_with_object([]) do |workflow, arr|
+          workflow.jobs.each do |job|
+            arr << job.container if job.container && !arr.include?(job.container)
+          end
+        end
+
+        if images.size > 1
+          error("More than one Docker image is used in the workflows,")
+          error("DOCKER_IMAGE option cannot be used.")
+          puts "Use DOCKER_IMAGE option for each job separately."
+          abort
+        end
+
+        ENV["DOCKER_IMAGE"]
+      end
+
+      # print the final result
+      # @param failed_jobs [Array<String>] list of failed jobs
+      def print_result(failed_jobs)
+        if failed_jobs.empty?
+          success("Overall result: SUCCESS")
+        else
+          error("Failed jobs: #{failed_jobs.inspect}")
+          error("Overall result: FAILURE!")
+          abort
+        end
+      end
+
+      # check if the job is valid and can be run locally,
+      # if the job cannot be used it prints a warning
+      # @return [Boolean] `true` if the job is valid, `false` otherwise
+      def valid_job?(job)
+        unsupported = job.unsupported_steps
+        if !unsupported.empty?
+          warning("WARNING: Skipping job \"#{job.name}\", found " \
+            "unsupported steps: #{unsupported.inspect}")
+          return false
+        end
+
+        if job.container.nil? || job.container.empty?
+          warning("WARNING: Skipping job \"#{job.name}\", " \
+            "the Docker container in not specified")
+          return false
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/tasks/pot.rake

@@ -27,19 +27,36 @@ task :pot do
 end
 
 namespace :check do
+
+  def interpolation_message
+    <<~MSG
+      Note: \#{foo} substitution in translatable strings does
+      not work properly, use
+        _("foo %{bar} baz") % { :bar => bar }
+      or
+        _("foo %s baz") % bar
+    MSG
+  end
+
+  def angle_brackets_message
+    <<~MSG
+      Note: %<foo> placeholder should not be used in translatable strings
+      because GNU Gettext does not support any suitable language format for that,
+      use %{foo} instead.
+    MSG
+  end
+
   # print failed lines and a hint to STDERR
-  def report_pot_errors(lines)
+  def report_pot_errors(lines, message)
+    return if lines.empty?
+
     warn "Failed lines:"
     warn "-" * 30
     warn lines
     warn "-" * 30
-    $stderr.puts
-    warn "Note: \#{foo} substitution in translatable strings does" \
-      " not work properly, use"
-    warn "  _(\"foo %{bar} baz\") % { :bar => bar }"
-    warn "or"
-    warn "  _(\"foo %s baz\") % bar"
-    $stderr.puts
+    warn ""
+    warn message
+    warn ""
   end
 
   # remove gettext keywords and extra quotes
@@ -53,7 +70,9 @@ namespace :check do
   end
 
   desc "Check translatable strings for common mistakes"
-  # depends on the global "pot" task defined above
+  # depends on the global "pot" task defined above,
+  # this scans for the #{} interpolations (do not work in translations)
+  # and %<> (no compatible language format in Gettext)
   task pot: :"rake:pot" do
     Dir["*.pot"].each do |pot|
       puts "Checking #{pot}..."
@@ -61,14 +80,18 @@ namespace :check do
       # remove comments
       lines.reject! { |line| line.match(/^#/) }
       # Ruby substitution present?
-      lines.select! { |line| line.include?("\#{") }
+      interpolations = lines.select { |line| line.include?("\#{") }
+      angle_brackets = lines.select { |line| line.include?("%<") }
+
+      next if interpolations.empty? && angle_brackets.empty?
+
+      clean_pot_lines(interpolations)
+      clean_pot_lines(angle_brackets)
 
-      clean_pot_lines(lines)
+      report_pot_errors(interpolations, interpolation_message)
+      report_pot_errors(angle_brackets, angle_brackets_message)
 
-      if !lines.empty?
-        report_pot_errors(lines)
-        raise "ERROR: Ruby substitution found in a translatable string"
-      end
+      raise "ERROR: Found invalid or unsupported translatable string"
     end
   end
 end

data/lib/tasks/run.rake

@@ -18,6 +18,8 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 #++
 
+require_relative "container_runner"
+
 def set_y2dir
   dirs = Dir["**/src"]
   dirs << ENV["Y2DIR"] if ENV["Y2DIR"] && !ENV["Y2DIR"].empty?
@@ -46,6 +48,15 @@ task :run, :client do |_t, args|
   sh "/sbin/yast2 #{client}"
 end
 
+desc "Run given client in a Docker container"
+task :"run:container", :client do |_t, args|
+  args.with_defaults = { client: nil }
+  client = args[:client]
+
+  runner = ContainerRunner.new
+  runner.run(client)
+end
+
 desc "Runs console with preloaded module directories"
 task :console do
   set_y2dir

data/lib/tasks/server.rake

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2020, 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 "../yast/tarball_server"
+
+# Rake task for running a source code web server,
+# designed for the `yupdate` script.
+desc "Start an HTTP server providing dynamically generated source code tarball"
+task :server, [:port] do |_task, args|
+  server = Yast::TarballServer.new(args[:port])
+
+  puts "Starting tarball webserver:"
+  server.addresses.each { |a| puts " * #{a}" }
+  puts
+
+  server.start
+end

data/lib/yast/index_servlet.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2020, 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 "webrick"
+
+module Yast
+  # a webrick servlet which returns a basic HTML info about the server,
+  # just to avoid that nasty 404 error page when someone opens the
+  # server URL in a web browser
+  class IndexServlet < WEBrick::HTTPServlet::AbstractServlet
+    INDEX_FILE = File.expand_path("../../data/index.html", __dir__)
+
+    def do_GET(_request, response)
+      response.status = 200
+      response.content_type = "text/html"
+      response.body = File.read(INDEX_FILE)
+    end
+  end
+end

data/lib/yast/servers_servlet.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2020, 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 "json"
+require "webrick"
+
+module Yast
+  # a webrick servlet which lists all rake servers running on this machine
+  class ServersServlet < WEBrick::HTTPServlet::AbstractServlet
+    def do_GET(_request, response)
+      response.status = 200
+      response.content_type = "application/json"
+      response.body = servers.to_json
+    end
+
+  private
+
+    # find the locally running "rake server" processes
+    def servers
+      output = `pgrep -a -f "rake server \\([0-9]+,.*\\)"`
+      output.lines.map do |l|
+        l.match(/rake server \(([0-9]+),(.*)\)/)
+        {
+          port: Regexp.last_match[1],
+          dir:  Regexp.last_match[2]
+        }
+      end
+    end
+  end
+end

data/lib/yast/tarball_server.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+#--
+# Yast rake
+#
+# Copyright (C) 2020, 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 "webrick"
+require "socket"
+
+require_relative "index_servlet"
+require_relative "servers_servlet"
+require_relative "tarball_servlet"
+
+module Yast
+  # a webrick server which provides the source tarballs
+  #
+  # the server handles these URL paths:
+  #   - "/archive/current.tar.gz" - the generated source code tarball
+  #   - "/servers/index.json" - index of the tarball servers running on this machine
+  #   - "/" - just a simple index page
+  #
+  # to stop the server press Ctrl+C
+  class TarballServer
+    # the default port number
+    DEFAULT_HTTP_PORT = 8000
+
+    attr_reader :port
+
+    # create all URLs valid for this machine, use all network interfaces
+    # (except the loop backs, the server will be used only from outside)
+    # @return [Array<String>] list of URLs
+    def addresses
+      # ignore the loopback addresses
+      hosts = Socket.ip_address_list.reject { |a| a.ipv4_loopback? || a.ipv6_loopback? }
+      # IPv6 addresses need to be closed in square brackets in URLs
+      hosts.map! { |a| a.ipv6? ? "[#{a.ip_address}]" : a.ip_address.to_s }
+      # include also the hostname to make it easier to write
+      hostname = Socket.gethostname
+      hosts << hostname if !hostname&.empty?
+      hosts.map! { |h| "http://#{h}:#{port}" }
+    end
+
+    # constructor
+    #
+    # @param port [Integer,nil] the port number, if nil the port will be found automatically
+    #
+    def initialize(port = nil)
+      @port = port || find_port
+    end
+
+    # start the webserver, it can be closed by pressing Ctrl+C or by sending SIGTERM signal
+    def start
+      dir = File.basename(Dir.pwd)
+      # change the process title so we can find the running
+      # servers and their ports just by simple grepping the running processes
+      Process.setproctitle("rake server (#{port},#{dir})")
+
+      # Use "*" to bind also the IPv6 addresses
+      server = WEBrick::HTTPServer.new(Port: port, BindAddress: "*")
+      server.mount("/archive/current.tar.gz", TarballServlet)
+      server.mount("/servers/index.json", ServersServlet)
+      server.mount("/", IndexServlet)
+
+      # stop the server when receiving a signal like Ctrl+C
+      # (inspired by the "un.rb" from the Ruby stdlib)
+      signals = ["TERM", "QUIT"]
+      signals.concat(["HUP", "INT"]) if $stdin.tty?
+      signals.each do |s|
+        trap(s) { server.shutdown }
+      end
+
+      server.start
+    end
+
+  private
+
+    # is the local port already taken by some other application?
+    # @param port [Integer] the port number
+    # @return [Boolean] true if the port is taken, false otherwise
+    def port_taken?(port)
+      # open the port and close it immediately, if that succeeds
+      # some other application is already using it
+      TCPSocket.new("localhost", port).close
+      true
+    rescue Errno::ECONNREFUSED
+      false
+    end
+
+    # find a free port starting from the default port number
+    # @return [Integer] the free port number
+    def find_port
+      DEFAULT_HTTP_PORT.step.find { |p| !port_taken?(p) }
+    end
+  end
+end