mdt-simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4e78e6ddc552236caaff39e45a695acaee2ad682ba422a380104494865f9c67
+  data.tar.gz: 5f61316be089655e08c25353a03314547f94a718baf058d6c63763d2c093c0c3
+SHA512:
+  metadata.gz: cd13c303849453679616a4c24b65857c217e92cba17ff79e9caf429478ed47d0adb07b5707d5398fb1d5d17379ff894d21ac9babd7d61d97995a0b7557ec594f
+  data.tar.gz: 796baf435a671a735cdd8e13d15c0113ad765e4ba2b4a4c2427b089cbc2e86ee40280d1bdc45477bdde7eb0586b1dcfb56fe9d5b24fdecdcc38aa5b374e1b080

data/README.md

@@ -0,0 +1,90 @@
+# MDT - Simple module
+
+A module with simple implementations for MDT.
+
+## Requirements
+
+* [mdt-core](https://github.com/Phitherek/mdt-core "mdt-core") >= 0.0.1
+* Ruby (tested with 2.5.0, earlier versions down to 2.0 may also work)
+* RubyGems
+
+## Installation
+
+`gem install mdt-dummy`
+
+## Usage
+
+The module is automatically loaded by `mdt`. All you need to do is to use appropriate keys in your `mdt-deploy.yml`.
+
+## Objects defined by module
+
+### Command modifiers
+
+* `simple.env` - prepends an environment variable to the command.
+Options:
+    * `name` - name of the variable
+    * `value` - value of the variable
+* `simple.sudo` - prepends sudo to the command.
+Options:
+    * `args` - arguments with options for sudo (optional)
+* `simple.generic` - prepends given string to the command.
+Options:
+    * `modifier_str` - string to prepend to the command
+### Commands
+
+* `simple.shell` - runs a command in a shell applying the command modifiers. Options:
+    * `shell` - the shell executable (optional, default: `/bin/bash`)
+    * `args` - arguments with options for the shell (optional)
+    * `command` - command to execute in the shell
+* `simple.system` - runs a command applying the command modifiers. Options:
+    * `command_string` - command to execute
+* `simple.mkdir` - creates a directory. Options:
+    * `path` - a path of a directory to be created
+    * `parents` - truthy if non-exising parents of the directory should be created too, falsey otherwise (empty also means falsey)
+* `simple.cd` - changes the working directory. Options:
+    * `path` - a path of the new working directory
+* `simple.cp` - copies files and directories from source to destination. Options:
+    * `source_path` - a path specifying the elements to be copied
+    * `destination_path` - a path specifying where the elements should be copied
+    * `recursive` - truthy if directories should be copied recursively, falsey otherwise (empty also means falsey)
+* `simple.mv` - moves files and directories from source to destination. Options:
+    * `source_path` - a path specifying the elements to be moved
+    * `destination_path` - a path specifying where the elements should be moved
+* `simple.rm` - removes files and directories. Options:
+    * `path` - a path specifying the elements to be removed
+    * `recursive` - truthy if directories should be removed recursively, falsey otherwise (empty also means falsey)
+    * `force` - truthy if the removal should be forced, falsey otherwise (empty also means falsey)
+* `simple.ln` - creates links. Options:
+    * `destination_path` - a path specifying what should be the destination of the link
+    * `link_name` - a path being the name of the link
+    * `symbolic` - truthy if the link should be symbolic, falsey otherwise (empty also means falsey)
+    * `force` - truthy if creation of the link should be forced, falsey otherwise (empty also means falsey)
+* `simple.chmod` - changes mode of files and directories. Options:
+    * `mode` - a mode to set
+    * `destination_path` - a path specifying where the mode should be changed
+    * `recursive` - truthy if the mode should be changed recursively, falsey otherwise (empty also means falsey)
+* `simple.chown` - changes owner of files and directories. Options:
+    * `user` - the user which should be the owner
+    * `group` - the group which should be the owner
+    * `destination_path` - a path specifying where the owner should be changed
+    * `recursive` - truthy if the owner should be changed recursively, falsey otherwise (empty also means falsey)
+* `simple.touch` - creates a file or updates its modification date. Options:
+    * `path` - a path specifying the file that should be touched
+
+### Directory choosers
+
+* `simple.directory` - uses a simple directory path. Creates and changes to the directory. Does not remove the directory on failure. Options:
+    * `path` - a path to the deploy directory
+    
+### Fetchers
+
+* `simple.directory` - uses a local directory. Options:
+    * `path` - a path to the source directory
+
+## Contributing
+
+You can contribute to the development of this MDT module by submitting an issue or pull request.
+
+## Documentation
+
+Generated RDoc documentation can be found [here](https://rubydoc.info/github/Phitherek/mdt-simple "here").

data/lib/mdt-simple.rb

@@ -0,0 +1,5 @@
+require_relative 'mdt/version'
+require_relative 'mdt/directory_choosers'
+require_relative 'mdt/fetchers'
+require_relative 'mdt/command_modifiers'
+require_relative 'mdt/commands'

data/lib/mdt/command_modifiers.rb

@@ -0,0 +1 @@
+require_relative 'command_modifiers/simple'

data/lib/mdt/command_modifiers/simple.rb

@@ -0,0 +1,50 @@
+require 'mdt-core'
+module MDT
+  # A module containing all command modifiers
+  module CommandModifiers
+    # A class that implements simple command modifiers
+    class Simple < MDT::CommandModifiers::Base
+      # A method that defines a key for command modifiers class.
+      # Returns:
+      # * "simple"
+      def self.key
+        'simple'
+      end
+
+      # A method that defines keys for available command modifiers.
+      # Returns:
+      # * +["env", "sudo", "generic"]+
+      def self.subkeys
+        ['env', 'sudo', 'generic']
+      end
+
+      # A method that defines how to prepend command modifiers to commands.
+      # Arguments:
+      # * +key+ - a key identifier of a particular command modifier
+      # * +command+ - a command to apply command modifier on
+      # * +options+ - options for modifier as a Hash
+      # Returns:
+      # * A value of +command+ modified with +key+ command modifier
+      # More information:
+      # * See README.md for detailed description of command modifiers
+      def prepend(key, command, options = {})
+        case key
+        when 'env'
+          if options['name'] && options['value']
+            "#{options['name']}=#{options['value']} #{command}"
+          else
+            command
+          end
+        when 'sudo'
+          "sudo #{options['args']} #{command}"
+        when 'generic'
+          if options['modifier_str']
+            "#{options['modifier_str']} #{command}"
+          else
+            command
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mdt/commands.rb

@@ -0,0 +1 @@
+require_relative 'commands/simple'

data/lib/mdt/commands/simple.rb

@@ -0,0 +1,230 @@
+require 'mdt-core'
+require 'fileutils'
+require 'open3'
+module MDT
+  # A module containing all commands
+  module Commands
+    # A class that implements simple commands
+    class Simple < MDT::Commands::Base
+      # A method that defines a key for commands class.
+      # Returns:
+      # * "simple"
+      def self.key
+        'simple'
+      end
+
+      # A method that defines keys for available commands.
+      # Returns:
+      # * +["shell", "system", "mkdir", "cd", "cp", "mv", "rm", "ln", "chmod", "chown", "touch"]+
+      def self.subkeys
+        ['shell', 'system', 'mkdir', 'cd', 'cp', 'mv', 'rm', 'ln', 'chmod', 'chown', 'touch']
+      end
+
+      # A method that defines how to execute a command and how to apply command modifiers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular command
+      # * +modifiers+ - an array of command modifier configurations - each configuration is a Hash that includes modifier type and modifier options
+      # * +options+ - options for command as a Hash
+      # Returns:
+      # * Exit code of command +key+
+      # More information:
+      # * See README.md for detailed description of commands
+      def execute(key, modifiers = [], options = {})
+        case key
+        when 'shell'
+          if options['command']
+            options['shell'] ||= '/bin/bash'
+            cmd = MDT::Helpers::Command.apply_command_modifiers(options['command'], modifiers)
+            puts "Running shell command: #{options['shell']} #{options['args']} -c \"#{cmd}\""
+            (cmd_stdout, cmd_stderr, status) = Open3.popen3("#{options['shell']} #{options['args']} -c \"#{cmd}\"") do |stdin, stdout, stderr, wait_thr|
+              exit_status = wait_thr.value
+              cmd_stdout = stdout.read
+              cmd_stderr = stderr.read
+              [cmd_stdout, cmd_stderr, exit_status]
+            end
+            puts
+            puts 'STDOUT:'
+            puts cmd_stdout
+            puts
+            puts 'STDERR:'
+            puts cmd_stderr
+            puts
+            status.exitstatus
+          else
+            1
+          end
+        when 'system'
+          if options['command_string']
+            cmd = MDT::Helpers::Command.apply_command_modifiers(options['command_string'], modifiers)
+            puts "Running command: #{cmd}"
+            (cmd_stdout, cmd_stderr, status) = Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+              exit_status = wait_thr.value
+              cmd_stdout = stdout.read
+              cmd_stderr = stderr.read
+              [cmd_stdout, cmd_stderr, exit_status]
+            end
+            puts
+            puts 'STDOUT:'
+            puts cmd_stdout
+            puts
+            puts 'STDERR:'
+            puts cmd_stderr
+            puts
+            status.exitstatus
+          else
+            1
+          end
+        when 'mkdir'
+          if options['path']
+            begin
+              if options['parents']
+                puts "Creating directory with parents: #{options['path']}"
+                FileUtils.mkdir_p(Dir[options['path']].first)
+              else
+                puts "Creating directory: #{options['path']}"
+                FileUtils.mkdir(Dir[options['path']].first)
+              end
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        when 'cd'
+          if options['path']
+            begin
+              puts "Changing working directory to: #{options['path']}"
+              FileUtils.cd(Dir[options['path']].first)
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        when 'cp'
+          if options['source_path'] && options['destination_path']
+            begin
+              if options['recursive']
+                puts "Copying recursively from: #{options['source_path']} to: #{options['destination_path']}"
+                FileUtils.cp_r(Dir[options['source_path']], Dir[options['destination_path']].first)
+              else
+                puts "Copying from: #{options['source_path']} to: #{options['destination_path']}"
+                FileUtils.cp(Dir[options['source_path']], Dir[options['destination_path']].first)
+              end
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        when 'mv'
+          if options['source_path'] && options['destination_path']
+            begin
+              puts "Moving from: #{options['source_path']} to: #{options['destination_path']}"
+              FileUtils.mv(Dir[options['source_path']], Dir[options['destination_path']].first)
+            rescue
+              1
+            end
+          else
+            1
+          end
+        when 'rm'
+          if options['path']
+            begin
+              if options['recursive'] && options['force']
+                puts "Removing recursively with force: #{options['path']}"
+                FileUtils.rm_rf(Dir[options['path']])
+              elsif options['recursive']
+                puts "Removing recursively: #{options['path']}"
+                FileUtils.rm_r(Dir[options['path']])
+              elsif options['force']
+                puts "Removing with force: #{options['path']}"
+                FileUtils.rm_f(Dir[options['path']])
+              else
+                puts "Removing: #{options['path']}"
+                FileUtils.rm(Dir[options['path']])
+              end
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        when 'ln'
+          if options['destination_path'] && options['link_name']
+            begin
+             if options['symbolic'] && options['force']
+               puts "Creating a symbolic link with force to: #{options['destination_path']} named: #{options['link_name']}"
+               FileUtils.ln_sf(Dir[options['destination_path']].first, Dir[options['link_name']].first)
+             elsif options['symbolic']
+               puts "Creating a symbolic link to: #{options['destination_path']} named: #{options['link_name']}"
+               FileUtils.ln_s(Dir[options['destination_path']].first, Dir[options['link_name']].first)
+             elsif options['force']
+               puts "Creating a link with force to: #{options['destination_path']} named: #{options['link_name']}"
+               FileUtils.ln_f(Dir[options['destination_path']].first, Dir[options['link_name']].first)
+             else
+               puts "Creating a link to: #{options['destination_path']} named: #{options['link_name']}"
+               FileUtils.ln(Dir[options['destination_path']].first, Dir[options['link_name']].first)
+             end
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        when 'chmod'
+          if options['mode'] && options['destination_path']
+            begin
+              if options['recursive']
+                puts "Changing mode recursively to: #{options['mode']} of: #{options['destination_path']}"
+                FileUtils.chmod_R(options['mode'], Dir[options['destination_path']])
+              else
+                puts "Changing mode to: #{options['mode']} of: #{options['destination_path']}"
+                FileUtils.chmod(options['mode'], Dir[options['destination_path']])
+              end
+            rescue
+              1
+            end
+            0
+          else
+            1
+          end
+        when 'chown'
+          if options['user'] && options['group'] && options['destination_path']
+            begin
+              if options['recursive']
+                puts "Changing owner recursively to: #{options['user']}:#{options['group']} of: #{options['destination_path']}"
+                FileUtils.chown_R(options['user'], options['group'], Dir[options['destination_path']])
+              else
+                puts "Changing owner to: #{options['user']}:#{options['group']} of: #{options['destination_path']}"
+                FileUtils.chown(options['user'], options['group'], Dir[options['destination_path']])
+              end
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        when 'touch'
+          if options['path']
+            begin
+              puts "Touching: #{options['path']}"
+              FileUtils.touch(Dir[options['path']])
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mdt/directory_choosers.rb

@@ -0,0 +1 @@
+require_relative 'directory_choosers/simple'

data/lib/mdt/directory_choosers/simple.rb

@@ -0,0 +1,88 @@
+require 'mdt-core'
+require 'fileutils'
+module MDT
+  # A module containing all directory choosers
+  module DirectoryChoosers
+    # A class that implements simple directory choosers
+    class Simple < MDT::DirectoryChoosers::Base
+      # A method that defines a key for directory choosers class.
+      # Returns:
+      # * "simple"
+      def self.key
+        'simple'
+      end
+
+      # A method that defines keys for available directory choosers.
+      # Returns:
+      # * +["directory"]+
+      def self.subkeys
+        ['directory']
+      end
+
+      # A method that defines how to create a deploy directory with directory choosers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular directory chooser
+      # * +options+ - options for directory chooser as a Hash
+      # Returns:
+      # * Exit code for directory chooser +key+
+      # More information:
+      # * See README.md for detailed description of directory choosers
+      def mkdir(key, options = {})
+        case key
+        when 'directory'
+          if options['path']
+            begin
+              puts "Creating directory: #{options['path']}"
+              FileUtils.mkdir_p(Dir[options['path']].first)
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        end
+      end
+
+      # A method that defines how to change working directory to a deploy directory with directory choosers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular directory chooser
+      # * +options+ - options for directory chooser as a Hash
+      # Returns:
+      # * Exit code for directory chooser +key+
+      # More information:
+      # * See README.md for detailed description of directory choosers
+      def cd(key, options = {})
+        case key
+        when 'directory'
+          if options['path']
+            begin
+              puts "Changing working directory to: #{options['path']}"
+              FileUtils.cd(Dir[options['path']].first)
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        end
+      end
+
+      # A method that defines how to remove a deploy directory with directory choosers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular directory chooser
+      # * +options+ - options for directory chooser as a Hash
+      # Returns:
+      # * Exit code for directory chooser +key+
+      # More information:
+      # * See README.md for detailed description of directory choosers
+      def rm(key, options = {})
+        case key
+        when 'directory'
+          0
+        end
+      end
+    end
+  end
+end

data/lib/mdt/fetchers.rb

@@ -0,0 +1 @@
+require_relative 'fetchers/simple'

data/lib/mdt/fetchers/simple.rb

@@ -0,0 +1,48 @@
+require 'mdt-core'
+require 'fileutils'
+module MDT
+  # A module containing all fetchers
+  module Fetchers
+    # A class that implements dummy fetchers
+    class Simple < MDT::Fetchers::Base
+      # A method that defines a key for fetchers class.
+      # Returns:
+      # * "simple"
+      def self.key
+        'simple'
+      end
+
+      # A method that defines keys for available fetchers.
+      # Returns:
+      # * +["directory"]+
+      def self.subkeys
+        ['directory']
+      end
+
+      # A method that defines how to fetch project contents to a deploy directory with fetchers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular fetcher
+      # * +options+ - options for fetchers as a Hash
+      # Returns:
+      # * Exit code for fetcher +key+
+      # More information:
+      # * See README.md for detailed description of fetchers
+      def fetch(key, options = {})
+        case key
+        when 'directory'
+          if options['path']
+            begin
+              puts "Fetching project data from directory: #{options['path']}"
+              FileUtils.cp_r(Dir[options['path'] + '/*'], Dir['.'].first)
+              0
+            rescue
+              1
+            end
+          else
+            1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mdt/version.rb

@@ -0,0 +1,8 @@
+# Global MDT module
+module MDT
+  # A module referring specifically to mdt-simple
+  module Simple
+    # mdt-simple gem version
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: mdt-simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Phitherek_
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mdt-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: A module with simple implementations for MDT
+email:
+- phitherek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/mdt-simple.rb
+- lib/mdt/command_modifiers.rb
+- lib/mdt/command_modifiers/simple.rb
+- lib/mdt/commands.rb
+- lib/mdt/commands/simple.rb
+- lib/mdt/directory_choosers.rb
+- lib/mdt/directory_choosers/simple.rb
+- lib/mdt/fetchers.rb
+- lib/mdt/fetchers/simple.rb
+- lib/mdt/version.rb
+homepage: https://github.com/Phitherek/mdt-simple
+licenses:
+- MIT
+metadata:
+  documentation_uri: http://www.rubydoc.info/github/Phitherek/mdt-simple
+  source_code_uri: https://github.com/Phitherek/mdt-simple
+post_install_message: 
+rdoc_options:
+- "--title"
+- MDT Simple module
+- "--main"
+- README.md
+- "--line-numbers"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: MDT Simple module
+test_files: []