RubyGems - yast-rake - Versions diffs - 0.2.36 → 0.2.37 - Mend

yast-rake 0.2.36 → 0.2.37

Files changed (9) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 604fa7a174e99d46c9d37b8ea3fff3d2d94ce7b6344a1d1c80bdec247203a56c
-  data.tar.gz: a8aa455360687b68e4879732c8e28bc6e430e68dd7a3e9cec14931c10d3c0c05
+  metadata.gz: 98b02611f30a453046b09d43d2a9475915d3f62ddaa25e86501a8dac1d7c34ac
+  data.tar.gz: 72c1f696a456ea27607324326863ff0ab902e1c02d6852fe91aafa692e267e5a
 SHA512:
-  metadata.gz: 176ca7514b8829e75d7f73d63d5279b1ac7eada517595db0a44689a84c21d71a4089136ac5cc062b0b828bade746292acb8f555248e8e24770c1d393690ce9b7
-  data.tar.gz: 623c0548088ad30f2c7c090444df16ce266ebfa09428b59ae52e4bfd3f4925e78430b3a4a908298dea1b331e08733fa023b0f068b19801754c1a761acaf1287b
+  metadata.gz: 8242f408e27684ee7a5888453f9efef2bb2922d4203dba46529391bb22926a65709ad522d52ce5c641fd74b3932a2d9f24b690e5d8b41193d952602593040833
+  data.tar.gz: 6780d86f72ed7cd3950238d15428a5c0d83e22284ec50e1601151bd8d5ae97a29e0113e46ab45cb1eb58f33bf879c2733d1427f92289688d803b2f9e358c01e2

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.2.36
1	+ 0.2.37

data/data/index.html ADDED

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<!-- This is a simple main page for the "rake server" task. -->
+<html>
+<head>
+  <title>Source Code Tarball Server</title>
+</head>
+<body>
+<h1>Source Code Tarball Server</h1>
+<p>This server provides dynamically generated source code tarballs.</p>
+<h2>Supported URL Paths</h2>
+<p>
+  <ul>
+    <li>
+      <b><a href = "/archive/current.tar.gz">/archive/current.tar.gz</a></b>
+      - dynamically generated tarball with the current source files
+    </li>
+    <li>
+        <b><a href = "/servers/index.json">/servers/index.json</a></b>
+        - index of other running servers on the machine
+    </li>
+  </ul>
+</p>
+</body>
+</html>

data/lib/tasks/server.rake ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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

data/lib/yast/tarball_servlet.rb ADDED

@@ -0,0 +1,55 @@
+# 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 dynamically creates a tarball
+  # with the content of the current Git checkout
+  class TarballServlet < WEBrick::HTTPServlet::AbstractServlet
+    def do_GET(_request, response)
+      response.status = 200
+      response.content_type = "application/gzip"
+      response.body = source_archive
+    end
+  private
+    # compress the current sources into a tarball,
+    # no caching to ensure we always provide the latest content
+    def source_archive
+      # pack all Git files (including the non-tracked files (-o),
+      # use --ignore-failed-read to not fail for removed files)
+      # -z and --null: NUL-delimited
+      git = "git ls-files --cached --others --exclude-standard -z"
+      tar = "tar --create --ignore-failed-read --null --files-from -"
+      `#{git} | #{tar} | #{gzip}`
+    end
+    # find which gzip is installed, use the faster parallel gzip ("pigz") if it is available
+    # @return [String] "pigz or "gzip"
+    def gzip
+      return @gzip if @gzip
+      # parallel gzip installed?
+      @gzip = system("which pigz") ? "pigz" : "gzip"
+    end
+  end
+end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yast-rake
 version: !ruby/object:Gem::Version
-  version: 0.2.36
+  version: 0.2.37
 platform: ruby
 authors:
 - Josef Reidinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packaging_rake_tasks
@@ -49,17 +49,23 @@ extra_rdoc_files: []
 files:
 - COPYING
 - VERSION
+- data/index.html
 - data/targets.yml
 - lib/tasks/install.rake
 - lib/tasks/pot.rake
 - lib/tasks/rubocop.rake
 - lib/tasks/run.rake
+- lib/tasks/server.rake
 - lib/tasks/spell.yml
 - lib/tasks/spellcheck.rake
 - lib/tasks/spellcheck_task.rb
 - lib/tasks/test_unit.rake
 - lib/tasks/version.rake
+- lib/yast/index_servlet.rb
 - lib/yast/rake.rb
+- lib/yast/servers_servlet.rb
+- lib/yast/tarball_server.rb
+- lib/yast/tarball_servlet.rb
 - lib/yast/tasks.rb
 homepage: https://github.com/yast/yast-rake
 licenses:
@@ -80,7 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project:
+rubygems_version: 2.7.6.2
 signing_key:
 specification_version: 4
 summary: Rake tasks providing basic work-flow for Yast development