drcheckr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00f1d677aa2849da5fb4eb2e50da96cade410467e1071bc9c3dc8ae4dd118b07
+  data.tar.gz: b38da04f13466a728631cc0a17797502d2b02a645d91b4bd89348fb7f47575cf
+SHA512:
+  metadata.gz: 2286c9b137ac7f1cbda269c72feaa8a1b6cf847aa33e075448bb5ba3bf88a3e31c401349a01ed42a10814423f3555fb402dcb7b3863a6d36db6ef4c72d89ba00
+  data.tar.gz: 01d69f20ddf2ac11b6577c8774b5e67be5918dc713023b39d65c22fd547b8de6c674837bb6683aa4e8ede9f05c7feca6daf709fae64f02bfb76ef9653d0e0aba

data/bin/drcheckr

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+begin
+  lib_dir = File.expand_path("#{__dir__}/../lib")
+  $:.unshift(lib_dir)
+end
+
+require 'drcheckr'
+
+Drcheckr::Cli.start(ARGV)

data/lib/drcheckr/checkrfile.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  class Checkrfile
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def lockfile?
+      File.file?(lockfile_path)
+    end
+
+    def full_path
+      @full_path ||= begin
+        path = @path
+        path = "#{path}/.drcheckr.yml" if File.directory?(path)
+        File.expand_path(path)
+      end
+    end
+
+    def lockfile_path
+      @lock_file_name ||= begin
+        base = File.basename(full_path)
+        ext = File.extname(base)
+        prefix = base[0..(-ext.length-1)]
+        lock_fn = "#{prefix}-lock#{ext}"
+        File.expand_path(File.join full_path, "..", lock_fn)
+      end
+    end
+
+    def variables
+      @variables ||= begin
+        YAML.safe_load(File.read full_path).fetch('variables', [])
+      end
+    end
+
+    def images
+      @images ||= begin
+        YAML.safe_load(File.read full_path).fetch('images')
+      end
+    end
+
+    def dependencies
+      @dependencies ||= begin
+        YAML.safe_load(File.read full_path).fetch('dependencies')
+      end
+    end
+
+    def locked_versions
+      return nil unless lockfile?
+
+      @locked_versions ||= begin
+        YAML.safe_load(File.read lockfile_path).fetch('dependencies')
+      end
+    end
+  end
+end

data/lib/drcheckr/cli.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  class Cli
+    def self.start(args)
+      new(args).run
+    end
+
+    def initialize(args)
+      @args = args
+      @options = {
+        checkrfile_path: nil,
+        variables: {}
+      }
+    end
+
+    def run
+      command = nil
+      inline_args = []
+
+      loop do
+        str = @args.shift
+        break unless str
+
+        if str == 'help' || str == '--help'
+          print_help
+          exit(0)
+        end
+
+        if str == '--set'
+          name, value = @args.shift.split('=', 2)
+          @options[:variables][name.to_sym] = value
+        end
+
+        if command
+          if command == 'expr'
+            inline_args << str
+          else
+            puts "Error: can't run multiple commands at once."
+            print_help
+            exit(1)
+          end
+        else
+          command = str
+        end
+      end
+
+      unless command
+        puts "Error: no command was specified"
+        print_help
+        exit(1)
+      end
+
+      case command
+      when 'check'
+        update_check
+      when 'gen'
+        gen_dockerfile
+      when 'update'
+        update_lockfile
+      when 'expr'
+        print_expression(inline_args)
+      else
+        puts "Error: unrecognized command: #{command}"
+        print_help
+        exit(1)
+      end
+    end
+
+    private
+
+    def print_help
+      puts "Usage: drcheckr <command> [options]"
+      puts "\nAvailable commands:"
+      puts " check - Checks whether dependencies are up to date"
+      puts " update - Like check, but persists new versions to the lock file"
+      puts " gen - Generates Dockerfile from existing lock file"
+      puts " expr <expression> - Evaluates and prints the given expression"
+      puts "\nOptions:"
+      puts " --set var=value - Can be used multiple times. Sets variable to the given value"
+    end
+
+    def checkrfile_path
+      @options[:checkrfile_path] || ENV.fetch('CHECKRFILE', 'drcheckr.yml')
+    end
+
+    def update_lockfile
+      c = Drcheckr::Commands::UpdateChecker.new(Checkrfile.new(checkrfile_path))
+      c.update!
+    end
+
+    def update_check
+      c = Drcheckr::Commands::UpdateChecker.new(Checkrfile.new(checkrfile_path))
+      c.check!
+    end
+
+    def print_expression(args)
+      if args.length != 1
+        puts "\"expr\" command expects one argument, but #{args.length} were given."
+        puts "aborting."
+        exit(1)
+      end
+
+      c = Drcheckr::Commands::ExpressionEvaluator.new(Checkrfile.new(checkrfile_path),
+        additional_vars: @options[:variables], expression: args.first)
+      c.run!
+    end
+
+    def gen_dockerfile
+      c = Drcheckr::Commands::GenDockerfile.new(Checkrfile.new(checkrfile_path),
+        additional_vars: @options[:variables])
+      c.run!
+    end
+  end
+end

data/lib/drcheckr/commands/expression_evaluator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  module Commands
+    class ExpressionEvaluator
+      def initialize(checkrfile, additional_vars: {}, expression:)
+        @checkrfile = checkrfile
+        @additional_vars = additional_vars
+        @expression = expression
+      end
+
+      def run!
+        context_data = ContextData.new(@checkrfile)
+
+        template = Tilt::ERBTemplate.new { @expression }
+        output = template.render(context_data.assemble(additional_vars: @additional_vars))
+        print output
+      end
+    end
+  end
+end

data/lib/drcheckr/commands/gen_dockerfile.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  module Commands
+    class GenDockerfile
+      attr_reader :checkrfile
+      attr_reader :params
+
+      def initialize(checkrfile, additional_vars:)
+        @checkrfile = checkrfile
+        @additional_vars = additional_vars
+      end
+
+      def run!
+        unless @checkrfile.lockfile?
+          puts "No lockfile found, aborting"
+          exit 1
+        end
+
+        missing_version = @checkrfile.dependencies.map{ |x| x['name'] } - @checkrfile.locked_versions.keys
+        unless missing_version.empty?
+          puts "Missing versions for the following dependencies:"
+          missing_version.each do |dep_name|
+            puts " - #{dep_name}"
+          end
+          puts "Can't proceed, aborting."
+          exit 1
+        end
+
+        puts "Will generate the following images:"
+        @checkrfile.images.each do |img|
+          puts "- #{img['name']}"
+        end
+
+        @checkrfile.images.each do |img|
+          image = img['name']
+          generator = Generator::ContainerFileGenerator.new(@checkrfile, image)
+          generator.generate
+        end
+      end
+    end
+  end
+end

data/lib/drcheckr/commands/update_checker.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  module Commands
+    class UpdateChecker
+      attr_reader :checkrfile
+
+      def initialize(checkrfile)
+        @checkrfile = checkrfile
+      end
+
+      def update!
+        check_pass
+
+        new_lock_file = checkrfile.locked_versions.dup
+        @outdated_list.each do |dep_name|
+          latest_version = @all_versions[dep_name].first
+          puts "Will update #{dep_name} to #{latest_version}"
+          new_lock_file[dep_name] = latest_version
+        end
+
+        if @outdated_list.empty?
+          puts "Everything up to date, no action needed!"
+          return
+        end
+        puts "Updating #{@outdated_list.length} dependencies"
+
+        dest_file = checkrfile.lockfile_path
+        data = YAML.dump({ 'dependencies' => new_lock_file })
+        File.write(dest_file, data)
+        puts "Wrote new dependencies to #{dest_file}"
+      end
+
+      def check!
+        if !checkrfile.lockfile?
+          puts "Lock file not present, can't check"
+          exit 1
+        end
+
+        check_pass
+
+        exit(0) if @outdated_list.empty?
+
+        puts("Found #{@outdated_list.length} outdated dependencies")
+        exit(122)
+      end
+
+      private
+
+      def check_pass
+        @all_versions = {}
+        @outdated_list = []
+        checkrfile.dependencies.each do |defn|
+          m = defn.key?('github') ? 'github' : nil
+          m ||= defn.key?('fixed_version') ? 'fixed_version' : nil
+          m ||= defn.key?('google_chrome') ? 'google_chrome' : nil
+          m ||= defn.key?('eol') ? 'eol' : nil
+
+          if !m
+            raise "Can't track dependency: #{defn}"
+          else
+            send("update_check_#{m}", defn)
+          end
+        end
+      end
+
+      def finish_check_dep_version(defn, versions)
+        undefined = Object.new
+        dep_name = defn['name']
+
+        @all_versions[dep_name] = versions
+
+        curr_version = (checkrfile.locked_versions || {})[dep_name]
+        if !curr_version
+          puts "No lock for dependency '#{dep_name}'"
+          curr_version = undefined
+        end
+
+        latest_version = versions[0]
+        if curr_version != latest_version
+          @outdated_list << dep_name
+
+          puts "Updates available for #{dep_name}!"
+          puts "\tCurrent version: #{curr_version == undefined ? '<undefined>' : curr_version}"
+          puts "\tLatest version: #{latest_version}"
+        else
+          puts "Dependency #{dep_name} is up to date"
+        end
+      end
+
+      def update_check_fixed_version(defn)
+        dep_name = defn['name']
+        version = defn['fixed_version']
+        puts "Skip check for #{dep_name}, fixed at #{version}"
+
+        finish_check_dep_version(defn, [version])
+      end
+
+      def update_check_google_chrome(defn)
+        platform, channel = defn['google_chrome'].split('/')
+        channel ||= 'stable'
+        resp = Excon.get("https://versionhistory.googleapis.com/v1/chrome/platforms/#{platform}/channels/#{channel}/versions")
+        data = JSON.parse(resp.body)
+        versions = data['versions'].map{ |x| x['version'] }
+        finish_check_dep_version(defn, versions)
+      end
+
+      def update_check_eol(defn)
+        name = defn['eol']
+        cycle = defn['cycle']
+
+        resp = Excon.get("https://endoflife.date/api/#{name}.json")
+        data = JSON.parse(resp.body)
+        data.select! { |x| x['cycle'] == cycle } if cycle
+
+        versions = data.map { |x| x['latest'] }
+        finish_check_dep_version(defn, versions)
+      end
+
+      def update_check_github(defn)
+        dep_name = defn['name']
+        repo_slug = defn['github']
+        puts "GH check #{dep_name}"
+
+        url = "https://github.com/#{repo_slug}/releases.atom"
+        resp = Excon.get(url, {
+          headers: {
+            'User-Agent' => "drcheckr/#{Drcheckr::VERSION}",
+            'Accept' => 'application/atom+xml',
+          }
+        })
+
+        doc = Nokogiri::XML(resp.body)
+        versions = []
+        doc.css('entry').each do |entry|
+          id = entry.css('id').text.strip
+          version = id.split('/').last
+
+          # puts "\t version |#{version}|"
+          versions << version
+        end
+
+        finish_check_dep_version(defn, versions)
+      end
+    end
+  end
+end

data/lib/drcheckr/context_data.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  class ContextData
+    def initialize(checkrfile)
+      @checkrfile = checkrfile
+      @data = {}
+    end
+
+    def []=(key, value)
+      @data[key.to_sym] = value
+    end
+
+    def assemble(**kw)
+      OpenStruct.new(to_h(**kw))
+    end
+
+    def to_h(additional_vars: {})
+      cdata = @data.dup
+
+      @checkrfile.locked_versions.each do |dep_name, version|
+        cdata["#{dep_name}_version".to_sym] = VersionNumber.parse(version)
+      end
+
+      cdata.merge! VariableLoader.new(@checkrfile).load(cdata, additional_vars)
+
+      cdata
+    end
+  end
+end

data/lib/drcheckr/generator/container_file_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  module Generator
+    class ContainerFileGenerator
+      def initialize(checkrfile, image_name, additional_vars: {})
+        @image_name = image_name
+        @checkrfile = checkrfile
+        @additional_vars = additional_vars
+      end
+
+      def generate
+        template = Tilt.new(template_path)
+
+        context_data = ContextData.new(@checkrfile)
+        context_data[:standard_banner] = make_standard_banner
+
+        final = template.render(context_data.assemble(additional_vars: @additional_vars))
+
+        dest_file = File.expand_path("#{@image_name}/Dockerfile")
+        File.write(dest_file, final)
+      end
+
+      private
+
+      def template_path
+        File.expand_path("#{@image_name}/Dockerfile.erb")
+      end
+
+      def make_standard_banner
+        header = ["GENERATED FILE, DO NOT EDIT!"]
+        header << "This was generated using drcheckr"
+        header << ""
+        header << "Dependencies:"
+        @checkrfile.locked_versions.each do |dep_name, version|
+          header << " - #{dep_name}: #{version}"
+        end
+
+        header << ""
+        header.map{ |x| "\# #{x}" }.join("\n")
+      end
+    end
+  end
+end

data/lib/drcheckr/variable_loader.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  class VariableLoader
+    def initialize(checkrfile)
+      @checkrfile = checkrfile
+    end
+
+    def load(current_context, additional_vars={})
+      locked_vars = YAML.safe_load(File.read @checkrfile.lockfile_path).fetch('variables', {})
+
+      out_context = {}
+      computed = []
+      @checkrfile.variables.each do |defn|
+        name = defn['name'].to_sym
+        if defn.key?('computed')
+          computed << defn
+        elsif defn.key?('value')
+          out_context[name] = defn['value']
+        else
+          out_context[name] = locked_vars.fetch(name.to_s)
+        end
+      end
+
+      computed_ctx = {}
+      computed.each do |cdefn|
+        name = cdefn['name'].to_sym
+        expr = cdefn['computed']
+
+        value = Tilt::ERBTemplate.new { expr }.render(OpenStruct.new current_context.merge(out_context))
+
+        computed_ctx[name] = value
+      end
+      out_context.merge!(computed_ctx)
+
+      out_context
+    end
+  end
+end

data/lib/drcheckr/version.rb

@@ -0,0 +1,4 @@
+
+module Drcheckr
+  VERSION = '0.1.0'
+end

data/lib/drcheckr/version_number.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Drcheckr
+  class VersionNumber
+    attr_reader :original
+    attr_reader :major, :minor, :patch
+
+    def self.parse(value)
+      new.tap { |x| x.parse(value) }
+    end
+
+    def to_s
+      @original
+    end
+
+    def semver(n=3)
+      mid = (["(\\d+)"] * n).join("\\.")
+      /^#{mid}$/.match(@original)
+    end
+
+    def semver?(n=3)
+      semver(n) != nil
+    end
+
+    def parse(value)
+      @original = value
+
+      begin
+        s = no_v.split(/[-\.]/)
+        @major = Integer(s[0])
+        @minor = s.length > 1 ? Integer(s[1]) : nil
+        @patch = s.length > 2 ? Integer(s[2]) : nil
+      rescue ArgumentError
+      end
+    end
+
+    def no_v
+      @original.start_with?('v') ? @original[1..] : @original
+    end
+    alias pure no_v
+
+    def major_minor
+      "#{@major}.#{@minor}"
+    end
+
+    def major_minor_patch
+      "#{@major}.#{@minor}.#{@patch}"
+    end
+  end
+end

data/lib/drcheckr.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'debug'
+
+require 'nokogiri'
+require 'excon'
+require 'json'
+require 'uri'
+require 'yaml'
+require 'tilt'
+require 'tilt/erb'
+require 'ostruct'
+require 'time'
+require 'date'
+
+module Drcheckr
+end
+
+require 'drcheckr/version'
+require 'drcheckr/cli'
+require 'drcheckr/version_number'
+require 'drcheckr/checkrfile'
+
+require 'drcheckr/context_data'
+require 'drcheckr/variable_loader'
+require 'drcheckr/generator/container_file_generator'
+
+require 'drcheckr/commands/update_checker'
+require 'drcheckr/commands/gen_dockerfile'
+require 'drcheckr/commands/expression_evaluator'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: drcheckr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- André Piske
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.111'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.111'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Tracks dependencies and generates Dockerfiles using ERB
+email:
+- andrepiske@gmail.com
+executables:
+- drcheckr
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/drcheckr
+- lib/drcheckr.rb
+- lib/drcheckr/checkrfile.rb
+- lib/drcheckr/cli.rb
+- lib/drcheckr/commands/expression_evaluator.rb
+- lib/drcheckr/commands/gen_dockerfile.rb
+- lib/drcheckr/commands/update_checker.rb
+- lib/drcheckr/context_data.rb
+- lib/drcheckr/generator/container_file_generator.rb
+- lib/drcheckr/variable_loader.rb
+- lib/drcheckr/version.rb
+- lib/drcheckr/version_number.rb
+homepage: https://github.com/trusted/drcheckr
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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.5.17
+signing_key:
+specification_version: 4
+summary: Dockerfile dependency tracker
+test_files: []