executo 0.3.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 918d5ac389754c1f27b8f8f4f299fe188e3c73f4f7ef12a8a3a186d1ebcb2c9f
+  data.tar.gz: 70add86102029bc613886c60e7eae2e18e0d21198f0ed936c9ef14192aa65565
+SHA512:
+  metadata.gz: e98b92d408bc2fade981fd061734402fc9a43f2d352c451bbb2de3e53a564273251772fa352f266d317a24b76c09b27916d562b18d00442198de940b84719bf6
+  data.tar.gz: 20807577dc4a072a526b784d6743b2365a2d5b02bc511009994c826a4cf6eca3a9c45d0f85dda5542ea78b1445c7a4aa71e6757f91dd31b6241c7e1c6895b50c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - "doc/**/*"
+    - "log/**/*"
+
+Metrics:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%": "[]"
+    "%i": "[]"
+    "%q": "[]"
+    "%Q": "[]"
+    "%r": "[]"
+    "%s": "[]"
+    "%w": "[]"
+    "%W": "[]"
+    "%x": "[]"
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tom@degrunt.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in executo.gemspec
+gem 'pry'
+
+gemspec
+
+gem "ruby-lsp", "~> 0.2.0", :group => :development
+gem "solargraph"

data/Gemfile.lock

@@ -0,0 +1,181 @@
+PATH
+  remote: .
+  specs:
+    executo (0.3.12)
+      active_attr (>= 0.15)
+      activejob (> 7.0.0)
+      activemodel (> 7.0.0)
+      activesupport (> 7.0.0)
+      redis (< 5)
+      sidekiq (> 5.1, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_attr (0.15.4)
+      actionpack (>= 3.0.2, < 7.1)
+      activemodel (>= 3.0.2, < 7.1)
+      activesupport (>= 3.0.2, < 7.1)
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    auxilium (3.0.24)
+      actionpack (> 5.1)
+      activemodel (> 5.1)
+      activesupport (> 5.1)
+      pundit (> 2)
+      responders (> 3)
+      rolify (> 5)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.3.0)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.0)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    nokogiri (1.13.9-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.9-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    prettier_print (0.1.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pundit (2.2.0)
+      activesupport (>= 3.0.0)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.8.0)
+    regexp_parser (2.5.0)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rolify (6.0.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-lsp (0.2.4)
+      language_server-protocol
+      sorbet-runtime
+      syntax_tree (>= 2.4)
+    ruby-progressbar (1.11.0)
+    sidekiq (6.5.8)
+      connection_pool (>= 2.2.5, < 3)
+      rack (~> 2.0)
+      redis (>= 4.5.0, < 5)
+    solargraph (0.47.2)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    sorbet-runtime (0.5.10386)
+    syntax_tree (3.5.0)
+      prettier_print
+    thor (1.2.1)
+    tilt (2.0.11)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-darwin-21
+
+DEPENDENCIES
+  auxilium (~> 3)
+  executo!
+  minitest (> 5.0)
+  pry
+  rake (> 10.0)
+  rubocop
+  ruby-lsp (~> 0.2.0)
+  solargraph
+
+BUNDLED WITH
+   2.3.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tom de Grunt
+
+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,66 @@
+# Executo
+
+Unix command execution from Rails. Jobs can be executed on remote servers, as long as they run executo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'executo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install executo
+
+## Usage
+
+```ruby
+Executo.publish('localhost', 'ls', ['-al'])
+```
+
+## Development
+
+Run worker using `sidekiq -r ./boot.rb -C sidekiq.yml`
+Run active-job worker using `sidekiq -r ./boot_activejob.rb`
+
+Publish jobs using:
+
+```ruby
+Executo.publish('localhost', 'ls', ['-al'])
+```
+
+You can publish jobs encrypted as well, which means that the command and parameters, but also passed options are encrypted before sent to the server (sidekiq/redis).
+They are only decrypted in memory for the command te be executed. Job options are never encrypted.
+This is ideal if you don't want email addresses or passwords to be littered over log files or in the redis database.
+
+Publish encrypted jobs using:
+
+```ruby
+Executo.publish('localhost', 'ls', ['-al'], encrypt: true)
+```
+
+Schedule for a host:
+
+```ruby
+Executo.schedule('localhost', [
+  ['30 * * * *', { class_name: '', arguments: {} }]
+])
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/executo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Executo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/entdec/executo/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Bundler.setup
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test
+
+# Adds the Auxilium semver task
+spec = Gem::Specification.find_by_name 'auxilium'
+load "#{spec.gem_dir}/lib/tasks/semver.rake"

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler'
+Bundler.require
+require 'executo'
+require File.join(Dir.pwd, 'boot.rb')
+
+Executo.setup do |config|
+  config.redis = { url: 'redis://localhost:6379/1' }
+  config.active_job_redis = { url: 'redis://localhost:6379/0' }
+end
+
+Pry.start

data/bin/executo

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup
+require 'executo'
+require File.join(Dir.pwd, 'boot.rb')
+
+Executo.publish(ARGV[0], ARGV[1..-1].join(' '))

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/sidekiq

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'sidekiq' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sidekiq', 'sidekiq')

data/bin/sidekiqctl

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'sidekiqctl' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sidekiq', 'sidekiqctl')

data/boot.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+Bundler.require
+require 'executo'
+require 'net/http'
+require 'uri'
+
+Sidekiq.strict_args!
+
+Executo.setup do |config|
+  config.redis = { url: 'redis://localhost:6379/1' }
+  config.active_job_redis = { url: 'redis://localhost:6379/0' }
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = Executo.config.redis
+  config.logger = Executo.config.logger.tagged('Sidekiq')
+end

data/boot_activejob.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'executo'
+require 'active_job'
+require 'pry'
+
+class LsProcessService < Executo::FeedbackProcessService
+  arguments :now
+
+  def perform
+    stdout&.each do |line|
+      logger.info line
+    end
+  end
+end
+
+Executo.setup do |config|
+  config.redis = { url: 'redis://localhost:6379/1' }
+  config.active_job_redis = { url: 'redis://localhost:6379/0' }
+end
+
+ActiveJob::Base.logger = Executo.config.logger.tagged('ActiveJob')
+ActiveJob::Base.logger.level = Logger::WARN
+
+Sidekiq.configure_server do |config|
+  config.logger = Executo.config.logger.tagged('Sidekiq')
+  config.logger.level = Logger::WARN
+  config.redis = { url: 'redis://localhost:6379/0' }
+end

data/executo.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'executo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'executo'
+  spec.version       = Executo::VERSION
+  spec.authors       = ['Tom de Grunt']
+  spec.email         = ['tom@degrunt.nl']
+
+  spec.summary       = 'Executes commands on remote servers'
+  spec.description   = 'Executes commands on remote servers'
+  spec.homepage      = 'https://github.com/entdec/excecuto'
+  spec.license       = 'MIT'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/entdec/excecuto'
+  spec.metadata['changelog_uri'] = 'https://github.com/entdec/excecuto'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = 'executo'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'active_attr', '>= 0.15'
+  spec.add_dependency 'activejob', '> 7.0.0'
+  spec.add_dependency 'activemodel', '> 7.0.0'
+  spec.add_dependency 'activesupport', '> 7.0.0'
+  spec.add_dependency 'sidekiq', '> 5.1', '< 7.0'
+  spec.add_dependency 'redis', '< 5'
+
+  spec.add_development_dependency 'auxilium', '~> 3'
+  spec.add_development_dependency 'minitest', '> 5.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '> 10.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/executo/cli.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'shellwords'
+
+module Executo
+  class CLI
+    class << self
+      def run(cmd, stdout:, stderr:, stdin_content: [], stdin_newlines: true, shell_escape: true)
+        raise 'cmd must be an array of Strings.' unless array_of_strings?(cmd)
+        raise 'stdout must be a Proc.' unless stdout.is_a?(Proc)
+        raise 'stderr must be a Proc.' unless stderr.is_a?(Proc)
+        raise 'stdin_content must be an Array of Strings.' unless array_of_strings?(stdin_content)
+
+        computed_cmd = escaped_command(cmd, shell_escape: shell_escape)
+        Executo.logger.debug "computed cmd: #{computed_cmd}"
+        Open3.popen3(computed_cmd) do |stdin_stream, stdout_stream, stderr_stream, thread|
+          threads = []
+          threads << write_stream(stdin_stream, stdin_content, newlines: stdin_newlines)
+          threads << read_stream(stdout_stream, stdout)
+          threads << read_stream(stderr_stream, stderr)
+          threads << thread
+
+          threads.each(&:join)
+          thread.value
+        end
+      end
+
+      def escaped_command(command, shell_escape: true)
+        return command.join unless shell_escape
+
+        command.shelljoin
+      end
+
+      def write_stream(stream, content, newlines: true)
+        Thread.new do
+          content.each do |input_line|
+            stream.write(input_line)
+            stream.write("\n") if input_line[-1] != "\n" && newlines
+          end
+        rescue Errno::EPIPE
+          nil
+        ensure
+          stream.close
+        end
+      end
+
+      def read_stream(stream, callback)
+        Thread.new do
+          until (line = stream.gets).nil?
+            callback.call(line)
+          end
+        rescue IOError
+          # ignore
+        end
+      end
+
+      def array_of_strings?(array)
+        array.is_a?(Array) && array.all? { |c| c.is_a?(String) }
+      end
+    end
+  end
+end