standard-procedure-anvil 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47f486a924f5bdee358e37587a81182f20578c61180508124ed2cef551b1fd62
-  data.tar.gz: 87f4d8498543db8f3aefd10ddd5e288bed1d9db89c47e84c82de2745bdd61a4a
+  metadata.gz: 826f4465c3c26af2077d355b53142e7755aa8897eceda3a030ef8dc024fa1a3a
+  data.tar.gz: c2e780bd49774ce57fc357210b10f867bd8edb1e3694698a0886527ab72d5d38
 SHA512:
-  metadata.gz: 92a3dbc97db730b1a55d31bdae8cae9b607f36070b2cee53b6dc386b1cfc755b13f57b90f6874c885882f4d08fd9cc6057dc5e520d9d8dcce7750339124ca518
-  data.tar.gz: b378044a88edce05a58234c9cca4c7878d7ed7ed25255e57b544392286d18458afffd5b709e51fe70e5e237df0a876111eb3cf4ed529ff2042ac2d8051aa6abd
+  metadata.gz: 0d0fe31b85a435a86777fd01de0e0a4c79356dff5f831872a74f0eb552a32f03479a9f5a8a8a371b56aa646e3a2f71d3cdbbdc6d5f8c42479356403f7e163485
+  data.tar.gz: f64d1bc0457cc69932acc4a8405206ee7e63c038e68655e2fb96ac10d31bb79a7dc221a5ea497c831cf701176a223bae828e8ce157635fcc12df579f8880f0e8

data/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:0-3-bullseye"
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/lib/anvil/cli.rb

@@ -18,11 +18,32 @@ class Anvil::Cli < Thor
   DESC
   option :private_key, type: :string, default: nil, aliases: "-k"
   option :passphrase, type: :string, default: nil, aliases: "-p"
-
   def install config = "anvil.yml", private_key = nil, passphrase = nil
     Anvil::Installer.new(configuration_from(config), private_key, passphrase).call
   end
 
+  desc "anvil deploy", "Deploy the current app"
+  long_desc <<-DESC
+    Deploy the current app to the server to the servers
+
+      Example:
+      `anvil deploy CONFIG`
+
+      The default CONFIG file is `anvil.yml` in the current directory.
+      Options:
+      --private_key, -k: The path to the key certificate file to use when connecting to the server.
+      --passphrase, -p: The passphrase to use when connecting to the server.
+  DESC
+  option :private_key, type: :string, default: nil, aliases: "-k"
+  option :passphrase, type: :string, default: nil, aliases: "-p"
+  def deploy config = "anvil.yml", private_key = nil, passphrase = nil
+  end
+
+  desc "anvil version", "Print the version of the anvil gem"
+  def version
+    puts Anvil::VERSION
+  end
+
   def self.exit_on_failure?
     true
   end

data/lib/anvil/server_installer/create_user.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Anvil::ServerInstaller::CreateUser < Struct.new(:ssh_connection, :user_name)
+  def call
+    script = <<~SCRIPT
+      if id -u #{user_name} >/dev/null 2>&1; then
+        echo "#{user_name} already exists"
+      else
+        echo "Adding #{user_name}"
+        adduser --disabled-password --gecos "" #{user_name}
+        usermod -aG sudo #{user_name}
+        usermod -aG docker #{user_name}
+        echo "#{user_name} ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
+        fi
+    SCRIPT
+    ssh_connection.exec! script, "CreateUser"
+  end
+end

data/lib/anvil/server_installer.rb

@@ -13,18 +13,20 @@ require_relative "logger"
 # - Configure nginx
 # - Install dokku plugins and run any configuration you have defined
 # - Disallows root and passwordless logins over SSH
-class Anvil::ServerInstaller < Struct.new(:hostname, :configuration, :private_key, :passphrase)
+# You can specify a custom logger or SSH executor using the options hash.
+class Anvil::ServerInstaller < Struct.new(:hostname, :configuration, :private_key, :passphrase, :options)
   require_relative "server_installer/set_hostname"
   require_relative "server_installer/set_timezone"
   require_relative "server_installer/install_packages"
-  require_relative "server_installer/create_users"
+  require_relative "server_installer/create_user"
   require_relative "server_installer/configure_dokku"
   require_relative "server_installer/configure_docker"
   require_relative "server_installer/install_plugins"
   require_relative "server_installer/configure_firewall"
   require_relative "server_installer/configure_ssh_server"
+
   def call
-    Anvil::SshExecutor.new(hostname, server_configuration["user"], logger).call do |ssh_connection|
+    ssh_executor.call do |ssh_connection|
       logger.info "SetHostname"
       Anvil::ServerInstaller::SetHostname.new(ssh_connection, hostname).call
       logger.info "SetTimezone"
@@ -34,7 +36,7 @@ class Anvil::ServerInstaller < Struct.new(:hostname, :configuration, :private_ke
       logger.info "ConfigureDokku"
       Anvil::ServerInstaller::ConfigureDokku.new(ssh_connection, hostname).call
       logger.info "CreateUsers"
-      Anvil::ServerInstaller::CreateUsers.new(ssh_connection, app_names).call
+      Anvil::ServerInstaller::CreateUser.new(ssh_connection, server_configuration["app_user"]).call
       logger.info "InstallPlugins"
       Anvil::ServerInstaller::InstallPlugins.new(ssh_connection, server_configuration["plugins"]).call
       logger.info "ConfigureDocker"
@@ -47,14 +49,18 @@ class Anvil::ServerInstaller < Struct.new(:hostname, :configuration, :private_ke
   end
 
   def server_configuration
-    configuration["server_config"]
+    configuration["server"]
   end
 
-  def app_names
-    configuration["apps"].keys
+  def options
+    super || {}
   end
 
   def logger
-    Anvil::Logger.new(hostname)
+    options[:logger].nil? ? Anvil::Logger.new(hostname) : options[:logger]
+  end
+
+  def ssh_executor
+    options[:ssh_executor].nil? ? Anvil::SshExecutor.new(hostname, server_configuration["install_user"], server_configuration["use_sudo"], logger) : options[:ssh_executor]
   end
 end

data/lib/anvil/ssh_executor.rb

@@ -2,18 +2,36 @@
 
 require "net/ssh"
 
-# The Installer reads the configuration and runs the ServerInstaller for each host.
-class Anvil::SshExecutor < Struct.new(:hostname, :user, :logger)
+# The SSH executor is responsible for executing scripts on a remote server via SSH.
+# It can be used with or without sudo
+# - without sudo it runs the scripts as supplied
+# - with sudo it creates a script on the remote server, runs it via sudo, and then deletes it
+# If supplied, it will also write the output of the script to a logger.
+class Anvil::SshExecutor < Struct.new(:hostname, :user, :use_sudo, :logger)
   def call &block
     @connection = Net::SSH.start hostname, user, use_agent: true
     block.call self
   end
 
   def exec! script, category = ""
-    @connection.exec! script do |channel, stream, data|
+    method = use_sudo ? :exec_with_sudo : :exec_without_sudo
+    send(method, script, category) do |channel, stream, data|
       data.to_s.split("\n") do |line|
-        logger.info line, category
+        logger&.info line, category
       end
     end
   end
+
+  protected
+
+  def exec_without_sudo script, category = "", &block
+    @connection.exec! script, &block
+  end
+
+  def exec_with_sudo script, category = "", &block
+    @connection.exec! "cat >> exec.sh << SCRIPT\n#{script}\nSCRIPT", &block
+    @connection.exec! "chmod 755 exec.sh", &block
+    @connection.exec! "sudo ./exec.sh", &block
+    @connection.exec! "rm exec.sh", &block
+  end
 end

data/lib/anvil/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anvil
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-anvil
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md
@@ -89,7 +90,7 @@ files:
 - lib/anvil/server_installer/configure_dokku.rb
 - lib/anvil/server_installer/configure_firewall.rb
 - lib/anvil/server_installer/configure_ssh_server.rb
-- lib/anvil/server_installer/create_users.rb
+- lib/anvil/server_installer/create_user.rb
 - lib/anvil/server_installer/install_packages.rb
 - lib/anvil/server_installer/install_plugins.rb
 - lib/anvil/server_installer/set_hostname.rb

data/lib/anvil/server_installer/create_users.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-class Anvil::ServerInstaller::CreateUsers < Struct.new(:ssh_connection, :names)
-  def call
-    names.collect do |name|
-      script = <<~SCRIPT
-        if id -u #{name} >/dev/null 2>&1; then
-          echo "#{name} already exists"
-        else
-          echo "Adding #{name}"
-          adduser --disabled-password --gecos "" #{name}
-          usermod -aG sudo #{name}
-          usermod -aG docker #{name}
-          echo "#{name} ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
-          fi
-      SCRIPT
-      ssh_connection.exec! script, "CreateUsers"
-    end
-  end
-end