dtc_rake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c817667aaedf7106b5c94e35686711cd05a1397e
+  data.tar.gz: 519d634e71da52759dbf46bfd0d6d4c2297e249f
+SHA512:
+  metadata.gz: 1e3fb74e9dc74d865c3822f206027800378089db348deece4b808fb325754aab5777e65c011612b557ec788f412f5784f6027eabaf277f28d9086473c4b3a9cf
+  data.tar.gz: 4aff5f658dce122c1e9ac33f97ad56b200b689ce2c2b55e2900219e813cef917fd5938367d4fb945dcae376c9cd7dbee452d4374e207ca72f302c1079a01f371

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dtc_rake.gemspec
+gemspec

data/README.md

@@ -0,0 +1,238 @@
+# dtc_rake
+
+Rake tasks for building apps produced by DTC.DEV team.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "dtc_rake", git: ""ssh://git@codebase.plus4u.net:9422/dtc.rake.git
+```
+
+And then execute:
+
+    $ bundle
+
+Or build it yourself from source as:
+
+    $ git clone ssh://git@codebase.plus4u.net:9422/dtc.rake.git
+    $ cd dtc.rake/dtc_rake
+    $ rake install
+
+# Quick Start
+
+For a quick start just add to your appbox project's `Rakefile`:
+
+```ruby
+require "dtc_rake"
+
+DtcRake.configure do |config|
+  config.appbox_uarchive = "<uarchive_path>"
+  config.appbox_territory_code = "<territory_code>"
+  config.appbox_meta_artifact_code = "<meta_artifact_code>"
+  config.appbox_location_code = "<folder_code>"
+end
+```
+
+*Note: The appbox project name should be `<vendor>_<app>-appbox` and it must contain a uuApp deployment descriptor with default name `<vendor>_<app>-uuapp.json`.*
+
+All shared tasks will be found and loaded automatically, you can verify it with `rake -T` command.
+
+It is recommended to check whether the defaults fit your needs and change the configuration if needed.
+
+Also set `DTC_RAKE_PASSWD` environment variable. It represents path to password file with authentication credentials (necessary for appbox creation and packs uploading). Its value can be either path relative to `uu.home` or an absolute path.
+
+Example:
+
+```sh
+rake upload:cmd DTC_RAKE_PASSWD=12-345-6
+# or
+rake upload:cmd DTC_RAKE_PASSWD=/path/to/12-345-6
+```
+
+*Tip: If you set `DTC_RAKE_PASSWD` globally (e.g. in your `.bash_profile` or `.zshenv`), you won't have to set it everytime you use Rake tasks from this gem.*
+
+# Documentation
+
+TODO Link to online yardoc
+
+## Configuration
+
+The following example shows all configuration options:
+
+
+```ruby
+require "dtc_rake"
+
+DtcRake.configure do |config|
+  # Code of application. Guessed from root_dir name if not set.
+  config.app = "<app_code>"
+
+  # Code of appbox artifact. Guessed from vendor, app and version in uuApp
+  # deployment descriptor if not set.
+  config.appbox_artifact_code = "<artifact_code>"
+
+  # Code of appbox location (folder or organization unit). Required.
+  config.appbox_location_code = "<folder_code>"
+
+  # Code of appbox meta artifact. Default value: UU.OS/RUNTIME/APP_BOX.
+  config.appbox_meta_artifact_code = "<meta_artifact_code>"
+
+  # Code of territory where the appbox artifact is / should be. Required.
+  config.appbox_territory_code = "<territory_code>"
+
+  # Path to uarchive with contents of appbox artifact. Default value: nil.
+  # If not set, appbox is created with empty content.
+  # Relative path is relative to root_dir.
+  config.appbox_uarchive = "<uarchive_path>"
+
+  # Path to uuApp deployment descriptor. Guessed from vendor and app if not set.
+  config.app_descriptor_path = "<deployment_descriptor_path>"
+
+  # Print messages in colors. Default value: true.
+  config.colorize = true
+
+  # Name of folder with build products. Default value: target.
+  # Relative path is relative to root_dir.
+  config.output_dir = "target"
+
+  # Appbox project root folder. Default value: current working directory.
+  config.root_dir = Dir.pwd
+
+  # Upload uuApp deployment descriptor to appbox artifact. Default value: false.
+  config.upload_app_descriptor = true
+
+  # Code of vendor. Guessed from root_dir name if not set.
+  config.vendor = "<vendor_code>"
+end
+```
+
+## Explanation of Provided Tasks
+
+### appbox
+
+Creates new appbox artifact.
+
+### build:all
+
+Builds all available packs. Which packs get built depends on which projects exist for the app being built.
+
+Example:
+
+Only tasks for building command client and server would be available for app with the following structure.
+
+```
+cds.gb
+  +- cds_gb
+  +- cds_gb-appbox
+     +- Rakefile
+  +- cds_gb-cmd
+```
+
+### build:cmd
+
+Builds pack with command server. Available if project `<vendor>_<app>-cmd` exists.
+
+### build:dockerfiles
+
+Builds pack with `Dockerfile`s. Available if project `<vendor>_<app>-dockerfiles` exists.
+
+### build:gem
+
+Builds pack with command client Ruby gem. Available if project `<vendor>_<app>` exists.
+
+### build:vuc
+
+Builds pack with visual use cases. Available if project `<vendor>_<app>-vuc` exists.
+
+### build:yardoc
+
+Builds pach with command client yardoc. Available if project `<vendor>_<app>` exists.
+
+### upload:all
+
+Uploads all available packs to appbox artifact. Which packs get uploaded depends on which projects exist for the app being built. See example for the `build:all` task.
+
+### upload:cmd
+
+Uploads pack with command server to appbox artifact. Available if project `<vendor>_<app>-cmd` exists.
+
+Requires `DTC_RAKE_PASSWD` to be set.
+
+### upload:descriptor
+
+Uploads uuApp deployment descriptor to appbox artifact. Available if `config.upload_app_descriptor` is set to `true`.
+
+Requires `DTC_RAKE_PASSWD` to be set.
+
+### upload:dockerfiles
+
+Uploads pack with `Dockerfile`s to appbox artifact. Available if project `<vendor>_<app>-dockerfiles` exists.
+
+Requires `DTC_RAKE_PASSWD` to be set.
+
+### upload:gem
+
+Uploads pack with command client Ruby gem to appbox artifact. Available if project `<vendor>_<app>` exists.
+
+Requires `DTC_RAKE_PASSWD` to be set.
+
+### upload:vuc
+
+Uploads pack with visual use cases to appbox artifact. Available if project `<vendor>_<app>-vuc` exists.
+
+Requires `DTC_RAKE_PASSWD` to be set.
+
+### upload:yardoc
+
+Uploads pach with command client yardoc to appbox artifact. Available if project `<vendor>_<app>` exists.
+
+Requires `DTC_RAKE_PASSWD` to be set.
+
+# How-to
+
+## How to Add Custom Task
+
+When a project requires a specific Rake task then implement it and add it to a shared task as dependency:
+
+```ruby
+namespace :build do
+  desc "Builds pack with widget"
+  task :widget do
+    ...
+  end
+end
+task "build:all" => "widget"
+```
+
+## How to Remove a Task
+
+If there is a task that doesn't make sense for you then you can exclude it from loading.
+
+For example, to exclude the `upload:dockerfiles`, replace the `require`
+
+```ruby
+require "dtc_rake"
+```
+
+with
+
+```ruby
+require "dtc_rake/tasks"
+DtcRake::Tasks.load_tasks(exclude: ["upload_dockerfiles.rake"])
+```
+
+To remove check that is used also as dependency for e.g. `upload:all`, it is needed to remove it also from prerequisites of task. Example how to remove `upload:dockerfiles` and do not call it when building all packs.
+
+```ruby
+require "dtc_rake/tasks"
+DtcRake::Tasks.load_tasks(exclude: ["upload_dockerfiles.rake"])
+Rake::Task["upload:all"].prerequisites.delete("dockerfiles")
+```
+
+# Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :build

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dtc_rake"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

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/dtc_rake.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dtc_rake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dtc_rake"
+  spec.version       = DtcRake::VERSION
+  spec.authors       = ["Jan Sibil"]
+  spec.email         = ["21-1@plus4u.net"]
+
+  spec.summary       = %q{Rake tasks for building apps produced by DTC.DEV team.}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "json", "~> 1.8.3"
+  spec.add_runtime_dependency "rainbow", "~> 2.1.0"
+  spec.add_runtime_dependency "uu_os", "~> 0.19"
+
+  spec.add_development_dependency "bundler", "~> 1.13", ">= 1.13.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/dtc_rake/config.rb

@@ -0,0 +1,112 @@
+require "rake"
+require "pathname"
+
+module DtcRake
+  def configure(&block)
+    yield Config.instance
+  end
+  module_function :configure
+
+  class Config
+    include Singleton
+
+    def initialize
+      @root_dir   = Dir.pwd
+      @output_dir = "target"
+      @colorize   = true
+      @appbox_meta_artifact_code = "UU.OS/RUNTIME/APP_BOX"
+      @upload_app_descriptor = false
+      guess_vendor_and_app
+    end
+
+    # Code of application. Guessed from root_dir name if not set.
+    attr_accessor :app
+
+    # Code of appbox artifact. Guessed from vendor, app and version in uuApp
+    # deployment descriptor if not set.
+    attr_accessor :appbox_artifact_code
+
+    # Code of appbox location (folder or organization unit). Required.
+    attr_accessor :appbox_location_code
+
+    # Code of appbox meta artifact. Default value: UU.OS/RUNTIME/APP_BOX.
+    attr_accessor :appbox_meta_artifact_code
+
+    # Code of territory where the appbox artifact is / should be. Required.
+    attr_accessor :appbox_territory_code
+
+    # Path to uarchive with contents of appbox artifact. Default value: nil.
+    # If not set, appbox is created with empty content.
+    # Relative path is relative to root_dir.
+    attr_accessor :appbox_uarchive
+
+    # Path to uuApp deployment descriptor. Guessed from vendor and app if not set.
+    attr_accessor :app_descriptor_path
+
+    # Print messages in colors. Default value: true.
+    attr_accessor :colorize
+
+    # Name of folder with build products. Default value: target.
+    # Relative path is relative to root_dir.
+    attr_accessor :output_dir
+
+    # Appbox project root folder. Default value: current working directory.
+    attr_accessor :root_dir
+
+    # Upload uuApp deployment descriptor to appbox artifact. Default value: false.
+    attr_accessor :upload_app_descriptor
+
+    # Code of vendor. Guessed from root_dir name if not set.
+    attr_accessor :vendor
+
+    def app=(name)
+      @app = name.downcase unless name.nil?
+    end
+
+    def appbox_uarchive=(path)
+      unless path.nil?
+        path = File.join(root_dir, path) if Pathname.new(path).relative?
+        # File.expand_path converts path to absolute and expands "~" to real user home path
+        @appbox_uarchive = File.expand_path(path)
+      end
+    end
+
+    def app_descriptor_path
+      return @app_descriptor_path if @app_descriptor_path
+
+      default_file_path = File.expand_path(File.join(root_dir, "#{vendor}_#{app}-uuapp-deploy.json"))
+
+      Dir.chdir(root_dir) do
+        unless File.file?(default_file_path)
+          abort "uuApp deployment descriptor not found. Please create file #{default_file_path} or configure its path in Rakefile."
+        end
+        @app_descriptor_path = default_file_path
+      end
+    end
+
+    def output_dir=(path)
+      unless path.nil?
+        path = File.join(root_dir, path) if Pathname.new(path).relative?
+        # File.expand_path converts path to absolute and expands "~" to real user home path
+        @output_dir = File.expand_path(path)
+      end
+    end
+
+    def vendor=(name)
+      @vendor = name.downcase unless name.nil?
+    end
+
+    private
+
+    def guess_vendor_and_app
+      base_name = File.basename(root_dir)
+      if /([^_]+)_([^-]+)-appbox/ =~ base_name
+        @vendor = $1
+        @app = $2
+      else
+        abort "Appbox root folder (#{base_name}) does not match naming convention <vendor>_<app>-appbox." \
+          " Either change the folder name or configure 'vendor' and 'app' in Rakefile."
+      end
+    end
+  end
+end

data/lib/dtc_rake/product.rb

@@ -0,0 +1,137 @@
+require "rake"
+require "dtc_rake/config"
+require "dtc_rake/ui"
+require "json"
+require "uu/os/uesuri"
+
+module DtcRake
+  class Product
+    include Singleton
+    include DtcRake::UI
+
+    # Appbox version specified in deployment descriptor.
+    attr_reader :version
+
+    # UESURI of the appbox artifact.
+    attr_reader :appbox_uri
+
+    attr_reader :gem_project, :cmd_project, :vuc_project, :dockerfiles_project
+
+    attr_reader :has_gem, :has_cmd, :has_vuc, :has_dockerfiles
+
+    attr_reader :gem_file_name, :cmd_file_name, :vuc_file_name, :yardoc_file_name, :dockerfiles_file_name
+    attr_reader :gem_attachment_code, :cmd_attachment_code, :vuc_attachment_code, :yardoc_attachment_code, :dockerfiles_attachment_code
+
+    def initialize
+      config = Config.instance
+      root_dir = config.root_dir
+      sibling_dir_path = File.expand_path(File.join(root_dir, "../#{config.vendor}_#{config.app}"))
+
+      @gem_project = sibling_dir_path
+      @has_gem = File.directory?(@gem_project)
+
+      @cmd_project = "#{sibling_dir_path}-cmd"
+      @has_cmd = File.directory?(@cmd_project)
+
+      @vuc_project = "#{sibling_dir_path}-vuc"
+      @has_vuc = File.directory?(@vuc_project)
+
+      @dockerfiles_project = File.expand_path(File.join(root_dir, "../docker"))
+      @has_dockerfiles = File.directory?(@dockerfiles_project)
+    end
+
+    def app_descriptor
+      return @app_descriptor if @app_descriptor
+
+      File.open(Config.instance.app_descriptor_path, "r") do |f|
+        @app_descriptor = JSON.parse(f.read, symbolize_names: true)
+      end
+    end
+
+    def version
+      app_descriptor[:data][:version]
+    end
+
+    def appbox_uri
+      return @appbox_uri if @appbox_uri
+
+      config = Config.instance
+      error("Territory code is not set. Set it in DtcRake.configure (attribute appbox_territory_code) in your Rakefile.") if config.appbox_territory_code.nil?
+      appbox_artifact_code = config.appbox_artifact_code || "#{config.vendor.upcase}.#{config.app.upcase}_#{version}"
+      appbox_uri = UU::OS::UESURI.create(territory_code: config.appbox_territory_code, artifact_code: appbox_artifact_code)
+      @appbox_uri = appbox_uri
+    end
+
+    def gem_file_name
+      return @gem_file_name if defined? @gem_file_name
+      config = Config.instance
+      # TODO Read version from version.rb or allow to override it from within the Rakefile
+      # the actual gem version differs - e.g. uu_operation_registry-1.3.0.pre.BETA.1.gem (NOT uu_operation_registry-1.3.0-BETA.1.gem)
+      gem_version = version.sub(/-(ALPHA|BETA|RC)/) { |match| ".pre.#{$1}" }
+      @gem_file_name = "#{config.vendor}_#{config.app}-#{gem_version}.gem"
+    end
+
+    def cmd_file_name
+      return @cmd_file_name if defined? @cmd_file_name
+      config = Config.instance
+      # TODO Read version from version.rb or allow to override it from within the Rakefile
+      @cmd_file_name = "#{config.vendor}_#{config.app}-cmd-#{version}.war"
+    end
+
+    def vuc_file_name
+      return @vuc_file_name if defined? @vuc_file_name
+      config = Config.instance
+      # TODO Read version from version.rb or allow to override it from within the Rakefile
+      @vuc_file_name = "#{config.vendor}_#{config.app}-vuc-#{version}.war"
+    end
+
+    def dockerfiles_file_name
+      return @dockerfiles_file_name if defined? @dockerfiles_file_name
+      config = Config.instance
+      # TODO Read version from version.rb or allow to override it from within the Rakefile
+      @dockerfiles_file_name = "#{config.vendor}_#{config.app}-dockerfiles-#{version}.zip"
+    end
+
+    def yardoc_file_name
+      return @yardoc_file_name if defined? @yardoc_file_name
+      config = Config.instance
+      @yardoc_file_name = "#{config.vendor}_#{config.app}-yardoc-#{version}.zip"
+    end
+
+    def gem_attachment_code
+      return @gem_attachment_code if defined? @gem_attachment_code
+      config = Config.instance
+      @gem_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/GEM-PACK"
+    end
+
+    def cmd_attachment_code
+      return @cmd_attachment_code if defined? @cmd_attachment_code
+      config = Config.instance
+      @cmd_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/CMD-PACK"
+    end
+
+    def vuc_attachment_code
+      return @vuc_attachment_code if defined? @vuc_attachment_code
+      config = Config.instance
+      @vuc_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/VUC-PACK"
+    end
+
+    def dockerfiles_attachment_code
+      return @dockerfiles_attachment_code if defined? @dockerfiles_attachment_code
+      config = Config.instance
+      @dockerfiles_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/DOCKERFILES-PACK"
+    end
+
+    def yardoc_attachment_code
+      return @yardoc_attachment_code if defined? @yardoc_attachment_code
+      config = Config.instance
+      @yardoc_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/YARDOC-PACK"
+    end
+
+    def app_descriptor_attachment_code
+      return @app_descriptor_attachment_code if defined? @app_descriptor_attachment_code
+      config = Config.instance
+      @app_descriptor_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/UUAPP-DEPLOY"
+    end
+  end
+end

data/lib/dtc_rake/tasks.rb

@@ -0,0 +1,28 @@
+require "rake"
+
+module DtcRake
+  module Tasks
+    def load_tasks(params = {})
+      # a flag - load the tasks just once, multiple loading
+      # leads to multiple invocation of the same task
+      return if defined? @tasks_loaded
+
+      params[:exclude] ||= []
+      params[:include] ||= ["*.rake"]
+      filelist = {}
+
+      [:exclude, :include].each do |key|
+        filelist[key] = params[key].collect { |file| Dir[File.expand_path("#{File.dirname(__FILE__)}/../tasks/#{file}")] }
+        filelist[key].flatten!
+      end
+
+      # load an include file only if it not in the exclude list
+      filelist[:include].each do |ext|
+        load ext unless filelist[:exclude].include?(ext)
+      end
+
+      @tasks_loaded = true
+    end
+    module_function :load_tasks
+  end
+end

data/lib/dtc_rake/ui.rb

@@ -0,0 +1,49 @@
+module DtcRake
+  module UI
+    def error(msg)
+      msg = Rainbow(msg).red if colorize?
+      abort msg
+    end
+    module_function :error
+
+    def announce(msg)
+      msg = Rainbow(msg).aqua if colorize?
+      puts msg
+    end
+    module_function :announce
+
+    def success(msg)
+      msg = Rainbow(msg).green if colorize?
+      puts msg
+    end
+    module_function :success
+
+    def warning(msg)
+      msg = Rainbow(msg).yellow if colorize?
+      puts msg
+    end
+    module_function :warning
+
+    def info(msg)
+      msg = Rainbow(msg).white if colorize?
+      puts msg
+    end
+    module_function :info
+
+    private
+
+    def colorize?
+      return @colorize if defined? @colorize
+
+      colorize = Config.instance.colorize
+      if colorize
+        begin
+          require "rainbow"
+        rescue LoadError
+          colorize = false
+        end
+      end
+      @colorize = colorize
+    end
+  end
+end