mdt-versioned 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ad286f3fdb69b008ee34d111a797e611877aed3b1fda91e4402166e2536eaec
+  data.tar.gz: 24cab94d2d7fc333653567ecb4e055187ee5f34b0312f31bc083b234d7fae297
+SHA512:
+  metadata.gz: e4e95336d3bfdcf072cc26c310914f2410741de799213805535db58158c08c981130be849b317bfbe3630d9481ebe6896e40dff0aa5921af1c1a3fbcfb5d5884
+  data.tar.gz: d5e837e3a0ee7e94d883410149d7b4a477d349312c9cc42e807bad0bd15117b75fe5d66b8bbb72300c37371ea9e04208800ed97a5854ff8a92447051eca02546

data/README.md

@@ -0,0 +1,61 @@
+# MDT - Versioned module
+
+A module that implements versioned releases deployment flow for MDT.
+
+## Requirements
+
+* [mdt-core](https://github.com/Phitherek/mdt-core "mdt-core") >= 0.1.0
+* Ruby (tested with 2.5.0, earlier versions down to 2.0 may also work)
+* RubyGems
+
+## Installation
+
+`gem install mdt-versioned`
+
+## 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
+
+NOTE: All of the options are optional unless indicated otherwise.
+
+### Commands
+
+* `versioned.link_current` - creates a symlink to the current release version.
+Options:
+    * `current_name` - name of the link to the current release version, "current" by default.
+* `versioned.link_shared` - creates symlinks to the contents of the shared directory inside the current release directory.
+Options:
+    * `shared_name` - name of the shared directory, "shared" by default.
+* `versioned.cleanup` - deletes old releases. Options:
+    * `retained_versions_count` - number of releases to retain including current release, 2 by default.
+
+### Directory choosers
+
+* `versioned.integer` - uses versioned subdirectories based on increasing integer (1, 2, etc.). Creates and changes to the directory. Removes the directory on failure.
+Options:
+    * `path` - path of the base deployment directory. Required.
+    * `releases_dirname` - name of the directory that contains versioned release directories, "releases" by default.
+* `versioned.timestamp` - uses versioned subdirectories based on the formatted date and time.  Creates and changes to the directory. Removes the directory on failure.
+Options:
+    * `path` - path of the base deployment directory. Required.
+    * `releases_dirname` - name of the directory that contains versioned release directories, "releases" by default.
+    * `timestamp_format` - format of the timestamp as required by Ruby Time.strftime method, "%Y%m%d%H%M%S" by default.
+
+Both of the directory choosers set the following data in the MDT::DataStorage object:
+* `versioned_base_path` - path of the base deployment directory.
+* `versioned_version_id` - current version identifier.
+* `versioned_releases_dirname` - name of the directory that contains versioned release directories.
+
+## Data storage notice
+
+All of the data in the MDT::DataStorage object set by the directory choosers has to be set for this module's commands to work properly.
+
+## 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-versioned "here").

data/lib/mdt-versioned.rb

@@ -0,0 +1,3 @@
+require_relative 'mdt/version'
+require_relative 'mdt/directory_choosers'
+require_relative 'mdt/commands'

data/lib/mdt/commands.rb

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

data/lib/mdt/commands/versioned.rb

@@ -0,0 +1,74 @@
+require 'mdt-core'
+require 'fileutils'
+module MDT
+  # A module containing all commands
+  module Commands
+    # A class that implements commands for versioned releases flow
+    class Versioned < MDT::Commands::Base
+      # A method that defines a key for commands class.
+      # Returns:
+      # * "versioned"
+      def self.key
+        'versioned'
+      end
+
+      # A method that defines keys for available commands.
+      # Returns:
+      # * +["link_current", "link_shared", "cleanup"]+
+      def self.subkeys
+        ['link_current', 'link_shared', 'cleanup']
+      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 'link_current'
+          begin
+            options['current_name'] ||= 'current'
+            puts "Creating a symlink to: #{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id} named: #{MDT::DataStorage.instance.versioned_base_path}/#{options['current_name']}"
+            FileUtils.rm_f(Dir["#{MDT::DataStorage.instance.versioned_base_path}/#{options['current_name']}"])
+            FileUtils.ln_s(Dir["#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"].first, "#{MDT::DataStorage.instance.versioned_base_path}/#{options['current_name']}")
+            0
+          rescue
+            1
+          end
+        when 'link_shared'
+          begin
+            options['shared_name'] ||= 'shared'
+            puts "Creating symlinks to: #{MDT::DataStorage.instance.versioned_base_path}/#{options['shared_name']}/* at: #{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"
+            FileUtils.ln_s(Dir["#{MDT::DataStorage.instance.versioned_base_path}/#{options['shared_name']}/*"], Dir["#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"].first)
+            0
+          rescue
+            1
+          end
+        when 'cleanup'
+          options['retained_versions_count'] ||= 2
+          begin
+            puts 'Cleaning up old releases...'
+            versions = []
+            Dir["#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/*"].each do |vn|
+              versions << vn.split('/').last
+            end
+            versions.sort!
+            if versions.count > options['retained_versions_count']
+              versions.first(versions.count-options['retained_versions_count']).each do |v|
+                FileUtils.rm_rf("#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{v}")
+              end
+            end
+            0
+          rescue
+            1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mdt/directory_choosers.rb

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

data/lib/mdt/directory_choosers/versioned.rb

@@ -0,0 +1,108 @@
+require 'mdt-core'
+require 'fileutils'
+module MDT
+  # A module containing all directory choosers
+  module DirectoryChoosers
+    # A class that implements directory choosers for versioned releases flow
+    class Versioned < MDT::DirectoryChoosers::Base
+      # A method that defines a key for command modifiers class.
+      # Returns:
+      # * "versioned"
+      def self.key
+        'versioned'
+      end
+
+      # A method that defines keys for available command modifiers.
+      # Returns:
+      # * +["timestamp", "integer"]+
+      def self.subkeys
+        ['timestamp', 'integer']
+      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 = {})
+        return 1 unless options['path']
+        options['releases_dirname'] ||= 'releases'
+        case key
+        when 'timestamp'
+          begin
+            options['timestamp_format'] ||= '%Y%m%d%H%M%S'
+            MDT::DataStorage.instance.versioned_base_path = options['path']
+            MDT::DataStorage.instance.versioned_version_id = Time.now.strftime(options['timestamp_format'])
+            MDT::DataStorage.instance.versioned_releases_dirname = options['releases_dirname']
+            puts "Creating directory: #{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"
+            FileUtils.mkdir_p("#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}")
+            0
+          rescue => e
+            1
+          end
+        when 'integer'
+          begin
+            if Dir.exist?("#{options['path']}/#{options['releases_dirname']}")
+              previous_versions = []
+              Dir["#{options['path']}/#{options['releases_dirname']}/*"].each do |vd|
+                previous_versions << vd.split('/').last
+              end
+              previous_versions.sort!
+              MDT::DataStorage.instance.versioned_version_id = (previous_versions.last.to_i + 1).to_s
+            else
+              MDT::DataStorage.instance.versioned_version_id = 1.to_s
+            end
+            MDT::DataStorage.instance.versioned_base_path = options['path']
+            MDT::DataStorage.instance.versioned_releases_dirname = options['releases_dirname']
+            puts "Creating directory: #{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"
+            FileUtils.mkdir_p("#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}")
+            0
+          rescue => e
+            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 = {})
+        return 1 unless self.class.subkeys.include?(key)
+        begin
+          puts "Changing working directory to: #{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"
+          FileUtils.cd(Dir["#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"].first)
+          0
+        rescue
+          1
+        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 = {})
+        return 1 unless self.class.subkeys.include?(key)
+        begin
+          puts "Removing directory: #{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"
+          FileUtils.rm_rf(Dir["#{MDT::DataStorage.instance.versioned_base_path}/#{MDT::DataStorage.instance.versioned_releases_dirname}/#{MDT::DataStorage.instance.versioned_version_id}"].first)
+          0
+        rescue
+          1
+        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-versioned
+  module Versioned
+    # mdt-versioned gem version
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: mdt-versioned
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Phitherek_
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-15 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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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 that implements versioned releases deployment for MDT
+email:
+- phitherek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/mdt-versioned.rb
+- lib/mdt/commands.rb
+- lib/mdt/commands/versioned.rb
+- lib/mdt/directory_choosers.rb
+- lib/mdt/directory_choosers/versioned.rb
+- lib/mdt/version.rb
+homepage: https://github.com/Phitherek/mdt-versioned
+licenses:
+- MIT
+metadata:
+  documentation_uri: http://www.rubydoc.info/github/Phitherek/mdt-versioned
+  source_code_uri: https://github.com/Phitherek/mdt-versioned
+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 Versioned module
+test_files: []