scc-foundation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '092e1a02ccd4f53cd7473a1fb1cc05ccbc4d4367645e7fc50b61723cccd8d99b'
+  data.tar.gz: f02e560aaee184a3b52b90e3f96c9c5088d9f9a5af8cd817d2ae668d133e732d
+SHA512:
+  metadata.gz: 8132e3bb90970b5eaa7c67b32026f513fb5b738a84b3574a9d4c954c75b4c5996d84752c6b557e8511cac4b3fdb18e658506434dcc6eaca88cc6f0d39063859d
+  data.tar.gz: 895dc6a721d3c933f737e745674c8d115d385874a3bda68098e8e588b6b0695310674a6e423d003db87b1a1c1d41b848f9c5c6c95eca089b73d595df53e8f28b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-31
+
+- Initial release

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scc.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :development, :test do
+  gem "rspec", "~> 3.0"
+  gem "standard", "~> 1.3"
+  gem "brakeman", require: false
+  gem "simplecov", require: false
+  gem "simplecov-cobertura", require: false
+  gem "debug"
+end

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    scc-foundation (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    brakeman (6.1.1)
+      racc
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    io-console (0.7.2)
+    irb (1.11.1)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.2)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.32.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.57.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    stringio (3.1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  brakeman
+  debug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  scc-foundation!
+  simplecov
+  simplecov-cobertura
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jose D. Gomez R.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Scc Foundation Helpers
+
+Foundational helpers for SCC Rails applications
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/exe/scc-build-deploy-manifest-from-git

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "scc/commands/build_manifest_from_git"
+
+exit Scc::Commands::BuildManifestFromGit.new.call(ARGV)

data/lib/scc/commands/build_manifest_from_git.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "optionparser"
+require "yaml"
+require "scc/deploy_info"
+
+module Scc
+  module Commands
+    class BuildManifestFromGit
+      def parse_args(argv)
+        options = {}
+        OptionParser.new do |opts|
+          opts.banner = "Usage: scc-build-deploy-manifest-from-git [options]"
+
+          opts.on("-o", "--output FILE", "Output file") do |file|
+            options[:output_file] = file
+          end
+
+          opts.on("-d", "--git-dir PATH", "Git root") do |git_root|
+            options[:git_root] = git_root
+          end
+
+          opts.on("-h", "--help", "Prints this help") do
+            options[:early_exit] = true
+            puts opts
+          end
+
+          opts.on("-v", "--version", "Prints gem version") do
+            options[:early_exit] = true
+            puts Scc::VERSION
+          end
+        end.parse!(argv)
+
+        options
+      end
+
+      def call(argv)
+        argv = %w[-h] if argv.empty?
+        options = parse_args(argv)
+
+        # early exits
+        return options[:early_exit] if options[:early_exit]
+
+        deploy_info = Scc::DeployInfo.from_git(root: options[:git_root])
+        deploy_info.extract!
+
+        open_and_yield(options[:output_file]) do |f|
+          f.puts(YAML.dump(deploy_info.to_poro))
+        end
+
+        0
+      rescue Scc::DeployInfo::Extractor::Git::NotAGitRootError => e
+        puts e.message
+        1
+      end
+
+      private
+
+      def open_and_yield(filepath)
+        output_file = $stdout
+
+        unless filepath.nil? || filepath == "-"
+          output_file = File.open(filepath, "w+")
+        end
+
+        yield output_file
+
+        output_file.close
+      end
+    end
+  end
+end

data/lib/scc/deploy_info/extractor/dummy.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Scc
+  class DeployInfo
+    module Extractor
+      class Dummy
+        def call
+          {
+            origin: "UNKNOWN",
+            deploy_ref: "UNKNOWN",
+            commit_sha: "UNKNOWN",
+            commit_date: "UNKNOWN",
+            commit_subject: "UNKNOWN"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/scc/deploy_info/extractor/error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "scc"
+
+module Scc
+  class DeployInfo
+    module Extractor
+      class Error < Scc::Error
+      end
+    end
+  end
+end

data/lib/scc/deploy_info/extractor/file.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "date"
+require "time"
+require "yaml"
+
+module Scc
+  class DeployInfo
+    module Extractor
+      class File < Dummy
+        class ManifestNotFound < Error
+        end
+
+        class ManifestEmpty < Error
+        end
+
+        class ManifestInvalid < Error
+        end
+
+        def initialize(filename: "deploy_info.yml")
+          @filename = filename
+          @origin = "file"
+        end
+
+        def call
+          loaded_yaml = YAML.safe_load_file(@filename, permitted_classes: [::Date, ::Time, ::DateTime],
+            symbolize_names: true)
+
+          raise ManifestEmpty, "Deploy manifest is empty" unless loaded_yaml
+          raise ManifestInvalid, "Deploy manifest is not a hash" unless loaded_yaml.is_a?(Hash)
+
+          deploy_info = super.merge(loaded_yaml.compact)
+
+          deploy_info[:origin] = "FILE"
+          deploy_info[:commit_date] = Scc::Utils.try_parse_date(deploy_info[:commit_date])
+          deploy_info
+        rescue ::Errno::ENOENT, Errno::EISDIR
+          raise ManifestNotFound, "Could not find manifest file in #{@filename}"
+        rescue ::Psych::Exception # YAML parsing errors
+          raise ManifestInvalid, "Could not parse YAML from manifest file"
+        end
+      end
+    end
+  end
+end

data/lib/scc/deploy_info/extractor/git.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "scc/utils"
+require "English"
+
+module Scc
+  class DeployInfo
+    module Extractor
+      class Git < Dummy
+        GIT_SHOW_SEPARATOR = "|-*-|"
+        GIT_SHOW_FORMAT = %w[%D %H %s %aI].join(GIT_SHOW_SEPARATOR).freeze
+
+        class NotAGitRootError < Error
+        end
+
+        attr_reader :root
+
+        def initialize(root: ".")
+          @root = root
+        end
+
+        def call
+          parts = Dir.chdir(root) do
+            IO.popen(git_show_command, err: "/dev/null", &:read).strip.split(GIT_SHOW_SEPARATOR)
+          end
+
+          raise NotAGitRootError, "'#{root}' is not a git repo" unless $CHILD_STATUS.success?
+
+          deploy_ref, commit_sha, commit_subject, commit_date = parts
+          deploy_ref = deploy_ref.split(" ")[2].to_s.tr(",", "")
+
+          commit_date = Utils.try_parse_date(commit_date)
+
+          super.merge({
+            deploy_ref: deploy_ref,
+            commit_sha: commit_sha,
+            commit_date: commit_date,
+            commit_subject: commit_subject,
+            origin: :git
+          }.compact)
+        rescue Errno::ENOENT
+          raise NotAGitRootError, "git root not found at '#{root}'"
+        end
+
+        private
+
+        def git_show_command
+          %w[git show -s].append("--format=tformat:#{GIT_SHOW_FORMAT}", "@")
+        end
+      end
+    end
+  end
+end

data/lib/scc/deploy_info.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "../scc"
+require_relative "../scc/utils"
+require_relative "deploy_info/extractor/error"
+
+module Scc
+  class DeployInfo
+    NULLABLE_ATTRS = %i[deploy_ref commit_sha commit_date commit_subject origin]
+    SENTINEL = "UNKNOWN"
+    attr_reader(*NULLABLE_ATTRS)
+    attr_reader :formatted_date
+
+    def initialize(extractor: nil)
+      @deploy_ref = deploy_ref
+      @commit_sha = commit_sha
+      @commit_date = commit_date
+      @commit_subject = commit_subject
+      @origin = origin
+      @extractor = extractor || Extractor::Dummy.new
+    end
+
+    def short_sha = commit_sha.to_s[..7]
+
+    def version_string
+      "#{deploy_ref}/#{short_sha} @ #{formatted_date}"
+    end
+
+    def to_poro
+      {
+        "deploy_ref" => deploy_ref,
+        "commit_sha" => commit_sha,
+        "commit_date" => commit_date,
+        "commit_subject" => commit_subject,
+        "origin" => origin
+      }
+    end
+
+    def extract!
+      attrs = @extractor.call
+      NULLABLE_ATTRS.each do |key|
+        value = attrs[key]
+        value = SENTINEL if value.nil? || (value.is_a?(String) && value.empty?)
+
+        send("#{key}=".to_sym, value)
+      end
+
+      self
+    end
+
+    def self.from_git(root: nil)
+      root ||= "."
+      new(extractor: Extractor::Git.new(root: root))
+    end
+
+    def self.from_file(filename: nil)
+      filename ||= "deploy_info.yml"
+      new(extractor: Extractor::File.new(filename: filename))
+    end
+
+    def self.for_env(env, root: nil, filename: nil)
+      if %w[test development].include?(env)
+        return from_git(root: root).extract!
+      end
+      from_file(filename: filename).extract!
+    rescue DeployInfo::Extractor::Error
+      new.extract!
+    end
+
+    private
+
+    attr_writer(*NULLABLE_ATTRS)
+
+    def commit_date=(value)
+      if value.respond_to?(:strftime)
+        @formatted_date = value.strftime("%d %b %Y %H:%M")
+      elsif value.is_a?(String) || value.nil?
+        @formatted_date = value
+      else
+        raise ArgumentError.new("value is not a Date-like nor a String type")
+      end
+
+      @commit_date = value
+    end
+  end
+end
+
+# require_relative './deploy_info/base'
+require_relative "deploy_info/extractor/dummy"
+require_relative "deploy_info/extractor/git"
+require_relative "deploy_info/extractor/file"

data/lib/scc/utils.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "date"
+require "time"
+
+module Scc
+  module Utils
+    module_function
+
+    def try_parse_date(date)
+      return nil if date.nil?
+      return date if date.is_a?(Date) || date.is_a?(Time) || date.is_a?(DateTime)
+
+      DateTime.parse(date)
+    rescue Date::Error
+      nil
+    end
+  end
+end

data/lib/scc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Scc
+  VERSION = "0.1.0"
+end

data/lib/scc.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "scc/version"
+
+module Scc
+  class Error < StandardError; end
+end

data/scc.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/scc/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "scc-foundation"
+  spec.version = Scc::VERSION
+  # TODO: change this to a more generic SCC Team
+  spec.authors = ["Jose D. Gomez R."]
+  spec.email = ["jose.gomez@suse.com"]
+
+  spec.summary = "Foundational helpers for our Rails applications"
+  spec.description = "A set of helper classes to share across workloads"
+  spec.homepage = "https://scc.suse.com/team"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/SUSE/scc-foundation"
+  spec.metadata["changelog_uri"] = "https://github.com/SUSE/scc-foundation/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: scc-foundation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose D. Gomez R.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-06 00:00:00.000000000 Z
+dependencies: []
+description: A set of helper classes to share across workloads
+email:
+- jose.gomez@suse.com
+executables:
+- scc-build-deploy-manifest-from-git
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/scc-build-deploy-manifest-from-git
+- lib/scc.rb
+- lib/scc/commands/build_manifest_from_git.rb
+- lib/scc/deploy_info.rb
+- lib/scc/deploy_info/extractor/dummy.rb
+- lib/scc/deploy_info/extractor/error.rb
+- lib/scc/deploy_info/extractor/file.rb
+- lib/scc/deploy_info/extractor/git.rb
+- lib/scc/utils.rb
+- lib/scc/version.rb
+- scc.gemspec
+homepage: https://scc.suse.com/team
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://scc.suse.com/team
+  source_code_uri: https://github.com/SUSE/scc-foundation
+  changelog_uri: https://github.com/SUSE/scc-foundation/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Foundational helpers for our Rails applications
+test_files: []