consist 0.1.0 → 0.1.1

data/lib/consist/cli.rb

@@ -1,4 +1,17 @@
 require "thor"
+require "sshkit"
+require "sshkit/dsl"
+
+require "consist/recipe"
+require "consist/recipes"
+require "consist/step"
+require "consist/consistfile"
+require "consist/commands/includes/stream_logger"
+require "consist/commands/includes/erbable"
+require "consist/commands/exec"
+require "consist/commands/upload"
+require "consist/commands/mutate"
+require "consist/commands/check"
 
 module Consist
   class CLI < Thor
@@ -6,9 +19,33 @@ module Consist
 
     map %w[-v --version] => "version"
 
-    desc "version", "Display consist version", hide: true
+    desc "version", "Display consist version"
     def version
       say "consist/#{VERSION} #{RUBY_DESCRIPTION}"
     end
+
+    desc "lightup", "Attempt to connect to a server and execute an idempotent statement."
+    def lightup(user, server)
+      puts "---> Attempting to connect to #{server} as #{user}"
+      on("#{user}@#{server}") do
+        as user do
+          execute "true"
+        end
+      end
+    end
+
+    desc "scaffold", "Apply a given recipe to (a) server(s)"
+    def scaffold(_recipe, server_ip)
+      Consist::Recipes.new(server_ip)
+    end
+
+    option :step, type: :string
+    option :consistfile, type: :string
+    desc "up", "Run a Consistfile against a server"
+    def up(server_ip)
+      specified_step = options[:step]
+      consistfile = options[:consistfile]
+      Consist::Consistfile.new(server_ip, consistfile:, specified_step:)
+    end
   end
 end

data/lib/consist/commands/check.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Consist
+  module Commands
+    class Check
+      def initialize(command)
+        @command = command
+      end
+
+      def perform!(executor)
+        status = @command[:status]
+
+        flag, val = if @command.has_key?(:path) && !@command[:path].nil?
+          ["d", @command[:path]]
+        else
+          ["f", @command[:file]]
+        end
+
+        exists = executor.test("[ -#{flag} #{val} ]")
+
+        if status == :exist && !exists
+          @command[:block].call
+        elsif status == :nonexistant && !exists
+          @command[:block].call
+        else
+          tense = if status == :exist
+            "should"
+          elsif status == :nonexistant
+            "shoudlnt"
+          end
+          puts "Checking path `#{status}` - `#{val}` - #{exists ? "exists" : "doesn't exist"} and #{tense} - skipping"
+        end
+      end
+    end
+  end
+end

data/lib/consist/commands/exec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Consist
+  module Commands
+    class Exec
+      include Erbable
+
+      def initialize(command)
+        @command = command
+      end
+
+      def perform!(executor)
+        @command[:commands].each do
+          executor.execute(erb_template(_1), interaction_handler: Consist::Commands::StreamLogger.new,
+                                             **@command[:params])
+        end
+      end
+    end
+  end
+end

data/lib/consist/commands/includes/erbable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Consist
+  module Commands
+    module Erbable
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      def erb_template(contents)
+        b = binding
+        Consist.config.keys.each do |key|
+          b.local_variable_set(key, Consist.config[key])
+        end
+        ERB.new(contents).result(b)
+      end
+
+      module ClassMethods
+      end
+    end
+  end
+end

data/lib/consist/commands/includes/stream_logger.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Consist
+  module Commands
+    class StreamLogger
+      def initialize(log_level = :info)
+        @log_level = log_level
+      end
+
+      def on_data(_command, _stream_name, data, _channel)
+        log(data)
+      end
+
+      private
+
+      def log(message)
+        SSHKit.config.output.send(@log_level, message) unless @log_level.nil?
+      end
+    end
+  end
+end

data/lib/consist/commands/mutate.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Consist
+  module Commands
+    class Mutate
+      include Erbable
+
+      def initialize(command)
+        @command = command
+      end
+
+      def perform!(executor)
+        delim = @command[:delim]
+        target_file = @command[:target_file]
+        target_string = erb_template(@command[:target_string])
+        match = erb_template(@command[:match])
+
+        case @command[:mode]
+        when :replace
+          cmd = "sed -i -E 's#{delim}#{match}#{delim}#{target_string}#{delim}' #{target_file} "
+        end
+
+        executor.execute(cmd, interaction_handler: Consist::Commands::StreamLogger.new)
+      end
+    end
+  end
+end

data/lib/consist/commands/upload.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Consist
+  module Commands
+    class Upload
+      include Erbable
+
+      def initialize(command)
+        @command = command
+      end
+
+      def perform!(executor)
+        # rubocop:disable Style/ClassEqualityComparison
+        if @command[:local_file].class == Symbol
+          puts "---> Uploading defined file #{@command[:local_file]}"
+          target_file = Consist.files.detect { |f| f[:id] == @command[:local_file] }
+          raise "\n\nNo declared file of ID `#{@command[:local_file]}`" unless target_file
+
+          contents = StringIO.new(erb_template(target_file[:contents]))
+          upload_defined_file(executor, contents, @command[:remote_path])
+        else
+          local_path = File.expand_path("../steps/#{@id}/#{@command[:local_file]}", __dir__)
+          upload(executor, local_path, @command[:remote_path])
+        end
+        # rubocop:enable Style/ClassEqualityComparison
+      end
+
+      def upload(executor, local_path, remote_path)
+        executor.send(:upload!, local_path, remote_path, interaction_handler: Consist::Commands::StreamLogger.new)
+      end
+
+      def upload_defined_file(executor, contents, remote_path)
+        executor.upload! contents, remote_path, interaction_handler: Consist::Commands::StreamLogger.new
+      end
+    end
+  end
+end

data/lib/consist/consistfile.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true37236
+
+module Consist
+  class << self
+    attr_accessor :files, :config
+  end
+
+  @files = []
+  @config = {}
+
+  class Consistfile
+    include SSHKit::DSL
+
+    def initialize(server_ip, specified_step:, consistfile:)
+      @server_ip = server_ip
+      @specified_step = specified_step
+      consistfile_path = if consistfile
+        File.expand_path(consistfile, Dir.pwd)
+      else
+        File.expand_path("Consistfile", Dir.pwd)
+      end
+
+      consistfile_contents = File.read(consistfile_path)
+      instance_eval(consistfile_contents)
+    end
+
+    def consist(&definition)
+      instance_eval(&definition)
+    end
+
+    def recipe(id, &definition)
+      recipe = Consist::Recipe.new(id, &definition)
+
+      puts "Executing Recipe: #{recipe.name}"
+
+      if @specified_step.nil?
+        recipe.steps.each { exec_step(_1) }
+      else
+        puts "Specific step targeted: #{@specified_step.to_sym}"
+        specified_step, *_rest = recipe.steps.select { _1.id === @specified_step.to_sym }
+        raise "Step with id #{@specified_step.to_sym} not found." unless specified_step
+
+        exec_step(specified_step)
+      end
+
+      puts "Execution of #{recipe.name} has completed."
+    end
+
+    def file(id, &definition)
+      return unless definition
+
+      contents = yield
+
+      Consist.files << {id:, contents:}
+    end
+
+    def config(id, val)
+      Consist.config[id] = val
+    end
+
+    private
+
+    def exec_step(specified_step)
+      puts "Executing Step: #{specified_step.name}"
+
+      on("#{specified_step.required_user}@#{@server_ip}") do
+        specified_step.perform(self)
+      end
+    end
+  end
+end

data/lib/consist/recipe.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Consist
+  class Recipe
+    def initialize(_id = nil, &definition)
+      @steps = []
+      instance_eval(&definition)
+    end
+
+    def name(name = nil)
+      @name = name if name
+      @name
+    end
+
+    def description(description = nil)
+      @description = description if description
+      @description
+    end
+
+    def user(user = nil)
+      @user = user if @user
+      @user
+    end
+
+    def steps(&block)
+      instance_eval(&block) if block
+      @steps
+    end
+
+    def step(step_name, &block)
+      if block
+        @steps << Step.new(id: step_name, &block)
+        return
+      end
+
+      target_path = File.join("../../", "steps", step_name.to_s, "step.rb")
+      step_path = File.expand_path(target_path, __FILE__)
+      step_content = File.read(step_path)
+      @steps << Step.new(id: step_name) { instance_eval(step_content) }
+    end
+  end
+end

data/lib/consist/recipes.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Consist
+  class Recipes
+    include SSHKit::DSL
+
+    def initialize(server_ip)
+      recipe_directory = File.expand_path("../recipes", __dir__)
+      recipes = Dir[File.join(recipe_directory, "*.rb")]
+
+      recipes.each do |recipe_file|
+        recipe_content = File.read(recipe_file)
+        recipe = Recipe.new { instance_eval(recipe_content) }
+
+        puts "Executing Recipe: #{recipe.name}"
+        recipe.steps.each do |step|
+          puts "Executing Step: #{step.name}"
+
+          on("#{step.required_user}@#{server_ip}") do
+            step.perform(self)
+          end
+        end
+
+        puts "Execution of #{recipe.name} has completed."
+      end
+    end
+  end
+end

data/lib/consist/step.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Consist
+  class Step
+    include SSHKit::DSL
+
+    def initialize(id:, &block)
+      @commands = []
+      @id = id
+      @required_user = :root
+      instance_eval(&block)
+    end
+
+    def id(id = nil)
+      @id = id if id
+      @id
+    end
+
+    def name(name = nil)
+      @name = name if name
+      @name
+    end
+
+    def required_user(user = nil)
+      @required_user = user if user
+      @required_user
+    end
+
+    def shell(message = "", params: {})
+      return unless block_given?
+
+      command = yield
+      commands = command.split(/(?<!\\)\n/).select { !_1.start_with?("#") }.compact
+
+      @commands << {message:, type: :exec, commands:, params:}
+    end
+
+    def mutate_file(mode:, target_file:, match:, target_string:, delim: "/", message: "")
+      @commands << {type: :mutate, mode:, message:, match:, target_file:, delim:, target_string:}
+    end
+
+    def upload_file(local_file:, remote_path:, message: "")
+      @commands << {message:, type: :upload, local_file:, remote_path:}
+    end
+
+    def check(status:, path: nil, file: nil, message: "", &block)
+      @commands << {type: :check, message:, status:, file:, path:, block: -> { instance_eval(&block) }}
+    end
+
+    def perform(executor)
+      @commands.each do |command|
+        banner(command[:message]) unless command[:message].empty?
+
+        execable = Object.const_get("Consist::Commands::#{command[:type].capitalize}").new(command)
+        executor.as @required_user do
+          execable.perform!(executor)
+        end
+      end
+    end
+
+    private
+
+    def banner(message)
+      return if message.empty?
+
+      msg = "********* #{message} ********"
+      puts "*" * msg.length
+      puts msg
+      puts "*" * msg.length
+    end
+  end
+end

data/lib/consist/thor_ext.rb

@@ -28,12 +28,12 @@ module Consist
         base.check_unknown_options!
       end
 
-      def start(given_args=ARGV, config={})
+      def start(given_args = ARGV, config = {})
         config[:shell] ||= Thor::Base.shell.new
         handle_help_switches(given_args) do |args|
           dispatch(nil, args, nil, config)
         end
-      rescue StandardError => e
+      rescue => e
         handle_exception_on_start(e, config)
       end
 

data/lib/consist/version.rb

@@ -1,3 +1,3 @@
 module Consist
-  VERSION = "0.1.0".freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/recipes/kamal_single_server.rb

@@ -0,0 +1,8 @@
+name "Kamal Single Server"
+description "Sets up a single server to run Kamal"
+user :root
+
+steps do
+  step :update_apt_packages
+  step :install_apt_packages
+end

data/lib/steps/install_apt_packages/step.rb

@@ -0,0 +1,19 @@
+name "Install APT packages"
+required_user :root
+
+shell "Installing essential packages" do
+  <<~EOS
+    apt-get -y remove systemd-timesyncd
+    timedatectl set-ntp no
+    apt-get -y install build-essential curl fail2ban git ntp vim
+    apt-get autoremove
+    apt-get autoclean
+  EOS
+end
+
+shell "Start NTP and Fail2Ban" do
+  <<~EOS
+    service ntp restart
+    service fail2ban restart
+  EOS
+end

data/lib/steps/update_apt_packages/apt_auto_upgrades

@@ -0,0 +1,3 @@
+APT::Periodic::AutocleanInterval "7";
+APT::Periodic::Update-Package-Lists "1";
+APT::Periodic::Unattended-Upgrade "1";

data/lib/steps/update_apt_packages/step.rb

@@ -0,0 +1,11 @@
+name "Update the APT packages"
+required_user :root
+
+upload_file message: "Uploading APT config...", local_file: "apt_auto_upgrades",
+  remote_path: "/etc/apt/apt.conf.d/20auto-upgrades"
+
+shell do
+  <<~EOS
+    apt-get update && apt-get upgrade -y
+  EOS
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: consist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - John McDowall
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2023-11-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -26,7 +54,7 @@ dependencies:
         version: '1.2'
 description:
 email:
-- j@jmd.fm
+- john@kantan.io
 executables:
 - consist
 extensions: []
@@ -37,11 +65,25 @@ files:
 - exe/consist
 - lib/consist.rb
 - lib/consist/cli.rb
+- lib/consist/commands/check.rb
+- lib/consist/commands/exec.rb
+- lib/consist/commands/includes/erbable.rb
+- lib/consist/commands/includes/stream_logger.rb
+- lib/consist/commands/mutate.rb
+- lib/consist/commands/upload.rb
+- lib/consist/consistfile.rb
+- lib/consist/recipe.rb
+- lib/consist/recipes.rb
+- lib/consist/step.rb
 - lib/consist/thor_ext.rb
 - lib/consist/version.rb
+- lib/recipes/kamal_single_server.rb
+- lib/steps/install_apt_packages/step.rb
+- lib/steps/update_apt_packages/apt_auto_upgrades
+- lib/steps/update_apt_packages/step.rb
 homepage: https://github.com/johnmcdowall/consist
 licenses:
-- MIT
+- LGPL-3.0
 metadata:
   bug_tracker_uri: https://github.com/johnmcdowall/consist/issues
   changelog_uri: https://github.com/johnmcdowall/consist/releases