deploymatic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12555f536cf8666ea1775d6aae612836b7276c6a0c32f302c7fd965b3809178e
+  data.tar.gz: bf088645b074786b553768566c826d6d1d6a960ffa6055d5cb8ab6b34c8448b7
+SHA512:
+  metadata.gz: 6a00806c4301a5b163bd55113ab376fb31c91d63689648f4019a869921c6c456d617bb73720efecc2d6561a5f00881cdf27e6afde4d46597d827b3fbfc8d7aef
+  data.tar.gz: dfcaf5c2a4404f26c5a45465565693916fd8c1b3752fa4e5f489e9f4a6ea3c55736386572f4f8e7bacc8086c7c1c1af81350139f278b5e2d2651ce12a211b0de

data/.rubocop.yml

@@ -0,0 +1,167 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.2.0
+  NewCops: enable
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+# Layout/IndentationConsistency:
+#   EnforcedStyle: indented_internal_methods
+
+Layout/LineLength:
+  Enabled: false
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 100
+  Exclude:
+    - test/**/*.rb
+
+Metrics/BlockNesting:
+  Max: 3
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 100
+  Exclude:
+    - test/**/*.rb
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+  Exclude:
+    - test/**/*.rb
+
+Metrics/PerceivedComplexity:
+  Max: 25
+
+Minitest/AssertInDelta:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+# Style/BlockDelimiters:
+#   Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+# Style/CombinableLoops:
+#   Enabled: false
+
+# Style/ConditionalAssignment:
+#   Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+  Exclude:
+    - test/**/*
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Style/GuardClause:
+#   Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+
+# Style/IfUnlessModifier:
+#   Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+# Style/MethodDefParentheses:
+#   Enabled: false
+
+# Style/NegatedIf:
+#   Enabled: false
+
+# Style/Next:
+#   Enabled: false
+
+# Style/NumericPredicate:
+#   Enabled: false
+
+# Style/OpenStructUse:
+#   Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+# Style/RescueModifier:
+#   Enabled: false
+
+# Style/SafeNavigation:
+#   Enabled: true
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/StringConcatenation:
+  Mode: conservative
+
+# Style/SymbolArray:
+#   Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 pioz
+
+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,72 @@
+# Deploymatic
+
+Deploymatic is a Ruby tool for deploying services on a remote host using Git and systemd. It automates the installation, deployment, and management of services, making it easier to maintain and operate your applications.
+
+## Installation
+
+Clone the repository and install the required gems:
+
+```bash
+gem install deploymatic
+```
+
+## Configuration
+
+Create a configuration file `.matic.yml` in the root of your project with the following structure:
+
+```yaml
+name: meteo_station_example
+ssh_user: pioz
+ssh_host: 192.168.0.243
+ssh_port: 22 # Optional, default 22
+repo: https://github.com/pioz/meteo_station_example.git
+install_dir: /home/pioz/meteo_station_example # Optional, default $HOME/<service_name>
+install_commands: # Optional
+  - bundle install
+  - rake db:migrate
+start_command: bundle exec puma -C config/puma.rb
+stop_command: pkill -f puma # Optional
+log_path: /path/to/log/file # Optional
+run_after: network-online.target # Optional
+start_limit_burst: 5 # Optional
+start_limit_interval_seconds: 10 # Optional
+environment_variables: # Optional
+  - RAILS_ENV=production
+  - SECRET_KEY_BASE=your_secret_key
+```
+
+## Usage
+
+Use `deploymatic` to manage your service. The available commands are:
+
+- **install**: Install the service on the remote host
+- **uninstall**: Uninstall the service
+- **deploy**: Deploy the latest version of the service
+- **start**: Start the service
+- **stop**: Stop the service
+- **restart**: Restart the service
+- **status**: Show the current status of the service
+- **show**: Display the systemd unit service file of the service
+
+### Example
+
+```bash
+deploymatic install
+deploymatic start
+```
+
+## Contributing
+
+1. Fork it (https://github.com/pioz/deploymatic/fork)
+2. Create your feature branch (`git checkout -b feature/new-feature`)
+3. Commit your changes (`git commit -am 'Add new feature'`)
+4. Push to the branch (`git push origin feature/new-feature`)
+5. Create a new Pull Request
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+For any questions or suggestions, please open an issue.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/exe/main.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/deploymatic'
+
+COMMANDS = {
+  install: 'Install the service on the remote host',
+  uninstall: 'Uninstall the service',
+  deploy: 'Deploy the latest version of the service',
+  start: 'Start the service',
+  stop: 'Stop the service',
+  restart: 'Restart the service',
+  status: 'Show the current status of the service',
+  show: 'Display systemd unit service file of the service'
+}.freeze
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "usage: #{$PROGRAM_NAME} [OPTIONS] {COMMAND}\n\n"
+  opts.banner += "Options:\n"
+
+  opts.on('-v', 'Print version') do |v|
+    options[:version] = v
+  end
+
+  opts.separator ''
+  opts.separator "Commands:\n"
+  COMMANDS.each do |command, desc|
+    opts.separator format('    %-10{command} %{desc}s', command: command, desc: desc)
+  end
+end
+
+begin
+  parser.parse!
+rescue OptionParser::InvalidOption
+  puts parser.help
+  exit 1
+end
+
+if options[:version]
+  puts Deploymatic::VERSION
+  exit 0
+end
+
+if ARGV.size != 1
+  puts parser.help
+  exit 1
+end
+
+command = ARGV.first
+unless COMMANDS.key?(command.to_sym)
+  puts parser.help
+  exit 1
+end
+
+runner = Deploymatic::Deployer.new('.matic.yml')
+runner.send(command)

data/lib/deploymatic/conf.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/string/inflections'
+
+module Deploymatic
+  class InvalidConfValueError < StandardError; end
+
+  Conf = Struct.new(
+    :name,
+    :ssh_user,
+    :ssh_host,
+    :ssh_port,
+    :repo,
+    :install_dir,
+    :install_commands,
+    :start_command,
+    :stop_command,
+    :log_path,
+    :run_after,
+    :start_limit_burst,
+    :start_limit_interval_seconds,
+    :enviroment_variables
+  ) do
+    def initialize(**args)
+      super(**args)
+      self.name = self.name.parameterize
+      self.install_dir ||= "$HOME/#{self.name}"
+    end
+
+    def check_required_fields
+      %i[name ssh_user ssh_host repo start_command install_dir].select do |field|
+        self.send(field).nil?
+      end
+    end
+
+    def check_required_fields!
+      fields = check_required_fields
+      case fields.size
+      when 0
+        nil
+      when 1
+        raise InvalidConfValueError.new("Invalid conf value: #{fields.first} is not valid.")
+      else
+        raise InvalidConfValueError.new("Invalid conf values: #{fields.join(', ')} are not valid.")
+      end
+    end
+
+    def url
+      url = "#{self.ssh_user}@#{ssh_host}"
+      url += ":#{self.ssh_port}" if self.ssh_port
+      return url
+    end
+  end
+end

data/lib/deploymatic/deployer.rb

@@ -0,0 +1,133 @@
+require 'debug'
+require 'erb'
+require 'ostruct'
+require 'sshkit'
+require 'sshkit/dsl'
+require 'yaml'
+
+module Deploymatic
+  class DeploymaticError < StandardError; end
+
+  class Deployer
+    include SSHKit::DSL
+
+    SSHKit::Backend::Netssh.configure do |ssh|
+      ssh.connection_timeout = 30
+      ssh.ssh_options = {
+        auth_methods: %w[publickey],
+        keepalive: true
+      }
+    end
+
+    def initialize(config_file_path)
+      @conf = Conf.new(**YAML.load_file(config_file_path))
+      @conf.check_required_fields!
+
+      result, ok = run(:echo, '$HOME')
+      raise DeploymaticError.new("Unable to retrieve the user's home directory on the remote host: #{result}") unless ok
+
+      @home_dir = result.strip
+      @conf.install_dir.gsub!('$HOME', @home_dir)
+    end
+
+    def install
+      # puts systemd_unit_file_to_string
+      _, ok = run(:systemd, '--version')
+      raise DeploymaticError.new('systemd is not installed on the remote host') unless ok
+
+      _, ok = run(:git, '--version')
+      raise DeploymaticError.new('git is not installed on the remote host') unless ok
+
+      result, ok = run(:ls, '/var/lib/systemd/linger/')
+      raise DeploymaticError.new("User #{@conf.ssh_user} is not in the lingering list") if !ok || !result.include?(@conf.ssh_user)
+
+      result, ok = run(:mkdir, '-p', @conf.install_dir)
+      raise DeploymaticError.new("Cannot create directory '#{@conf.install_dir}': #{result}") unless ok
+
+      result, ok = run(:git, 'clone', @conf.repo, '.', within: @conf.install_dir)
+      raise DeploymaticError.new("Cannot clone git repo '#{@conf.repo}': #{result}") unless ok
+
+      @conf.install_commands.to_a.each do |install_command|
+        result, ok = run(*install_command.split(/\s+/), within: @conf.install_dir)
+        raise DeploymaticError.new("Cannot run install command '#{install_command}': #{result}") unless ok
+      end
+
+      io = StringIO.new(systemd_unit_file_to_string)
+      path = unit_file_path
+      on(@conf.url) do
+        upload!(io, path)
+      end
+
+      result, ok = run(:systemctl, '--user', 'daemon-reload')
+      raise DeploymaticError.new("Cannot reload systemd daemon: #{result}") unless ok
+
+      result, ok = run(:systemctl, '--user', 'enable', @conf.name)
+      raise DeploymaticError.new("Cannot enable systemd service '#{@conf.name}': #{result}") unless ok
+    end
+
+    def uninstall
+      run(:systemctl, '--user', 'stop', @conf.name)
+      run(:systemctl, '--user', 'disable', @conf.name)
+      run(:rm, unit_file_path)
+      run(:systemctl, '--user', 'daemon-reload')
+      run(:rm, '-r', @conf.install_dir)
+    end
+
+    def deploy
+      result, ok = run(:git, 'pull', within: @conf.install_dir)
+      raise DeploymaticError.new("Cannot pull git repo '#{@conf.repo}': #{result}") unless ok
+
+      @conf.install_commands.to_a.each do |install_command|
+        result, ok = run(*install_command.split(/\s+/), within: @conf.install_dir)
+        raise DeploymaticError.new("Cannot run install command '#{install_command}': #{result}") unless ok
+      end
+
+      restart
+    end
+
+    %w[start stop restart].each do |command|
+      define_method command do
+        result, ok = run(:systemctl, '--user', command, @conf.name)
+        raise DeploymaticError.new("Cannot #{command} systemd service '#{@conf.name}': #{result}") unless ok
+      end
+    end
+
+    def status
+      result, ok = run(:systemctl, '--user', 'status', @conf.name)
+      raise DeploymaticError.new("Cannot #{command} systemd service '#{@conf.name}': #{result}") unless ok
+
+      puts result
+    end
+
+    def show
+      puts systemd_unit_file_to_string
+    end
+
+    private
+
+    def systemd_unit_file_to_string
+      raw_template = File.read(File.join(__dir__, 'systemd_service_file_template.erb'))
+      template = ERB.new(raw_template, trim_mode: '-')
+      return template.result(@conf.instance_eval { binding })
+    end
+
+    def run(command, *, within: '.')
+      result = nil
+      ok = false
+      on(@conf.url) do
+        within(within) do
+          result = capture(command, *, verbosity: Logger::INFO)
+          ok = true
+        rescue SSHKit::Command::Failed => e
+          result = e.message
+          ok = false
+        end
+      end
+      return result, ok
+    end
+
+    def unit_file_path
+      File.join(@home_dir, '.config/systemd/user', "#{@conf.name}.service").to_s
+    end
+  end
+end

data/lib/deploymatic/systemd_service_file_template.erb

@@ -0,0 +1,30 @@
+[Unit]
+Description=<%= name %>
+
+[Service]
+Type=simple
+Restart=always
+WorkingDirectory=<%= install_dir.gsub('$HOME', '%h') %>
+ExecStart=<%= start_command %>
+<% if stop_command -%>
+ExecStop=<%= stop_command %>
+<% end -%>
+<% if log_path -%>
+StandardOutput=append:<%= log_path %>
+StandardError=append:<%= log_path %>
+<% end -%>
+<% if run_after -%>
+After=<%= after %>
+<% end -%>
+<% if start_limit_burst -%>
+StartLimitBurst=<%= start_limit_burst %>
+<% end -%>
+<%- if start_limit_interval_seconds -%>
+StartLimitIntervalSec=<%= start_limit_interval_seconds %>
+<%- end -%>
+<% enviroment_variables.to_h.each do |key, value| -%>
+Environment=<%= key %>=<%= value %>
+<% end -%>
+
+[Install]
+WantedBy=default.target

data/lib/deploymatic/version.rb

@@ -0,0 +1,3 @@
+module Deploymatic
+  VERSION = '0.1.0'.freeze
+end

data/lib/deploymatic.rb

@@ -0,0 +1,6 @@
+require_relative 'deploymatic/conf'
+require_relative 'deploymatic/deployer'
+require_relative 'deploymatic/version'
+
+module Deploymatic
+end

data/sig/deploymatic.rbs

@@ -0,0 +1,4 @@
+module Deploymatic
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: deploymatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pioz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: |
+  This Ruby gem streamlines the deployment and management of services within a
+  Git repository by leveraging systemd. Designed to simplify the process of
+  installing and updating services, the gem enables automated deployment
+  operations. It integrates systemd functionalities to manage services as
+  daemons, allowing for monitoring, starting, stopping, and restarting services
+  directly through Git commands. Configuration is set up quickly and easily in
+  a YAML file, ensuring a user-friendly experience. The configuration and use
+  of this gem ensure greater operational efficiency, reducing the time and
+  effort required for manual service management.
+email:
+- epilotto@gmx.com
+executables:
+- main.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/main.rb
+- lib/deploymatic.rb
+- lib/deploymatic/conf.rb
+- lib/deploymatic/deployer.rb
+- lib/deploymatic/systemd_service_file_template.erb
+- lib/deploymatic/version.rb
+- sig/deploymatic.rbs
+homepage: https://github.com/pioz/deploymatic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pioz/deploymatic
+  source_code_uri: https://github.com/pioz/deploymatic
+  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.3
+signing_key:
+specification_version: 4
+summary: Deploy services on a Git repository using Systemd
+test_files: []