dtc_rake 0.2.0 → 1.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e936ce1dd8233c504fd550d981706106fbb4675
-  data.tar.gz: e49a236edd9125522bc8a74e027557959e763eb9
+  metadata.gz: b53d460f92926167b414acdc1707cb901d4df886
+  data.tar.gz: 3a3e4e80069f41e0e1f587306e40043317888be8
 SHA512:
-  metadata.gz: 670f9356dbb552ebd06f83c107457826e77ba035f87bd1e1071f57b11924c2931f99a3f8a87252fd59c27c3e0a36d62dfe86b5c7914b078fc3550bfc067cc08e
-  data.tar.gz: 2c7380af4f22b238f1642becc51e81b040d1f1cff2c57f49cc07496c45e8396fd7a5aa29b8081b968f5af02f6844bb17654dd8f5fa322b27087e15655a0ae8cd
+  metadata.gz: 30ab3c705160b028ffe6608776194bf49363c7d3ab7c671b1d6f3b0499dbd1dd2ed536a7ccccb6dd0697642b098f97e13b9f343318f9d38034a479a4e71c81d4
+  data.tar.gz: a240141486d2011d7a1292cc326dc34bdcd5744fb1685b5a996df3da75a02d8044fca10dfa1a8f5e1c12ddaac50312260e32293ee25a753c7c8da26c7da0c5e6

data/README.md

@@ -7,18 +7,16 @@ Rake tasks for building apps produced by DTC.DEV team.
 Add this line to your application's `Gemfile`:
 
 ```ruby
-gem "dtc_rake", git: ""ssh://git@codebase.plus4u.net:9422/dtc.rake.git
+gem "dtc_rake"
 ```
 
 And then execute:
 
     $ bundle
 
-Or build it yourself from source as:
+Or install it yourself as:
 
-    $ git clone ssh://git@codebase.plus4u.net:9422/dtc.rake.git
-    $ cd dtc.rake/dtc_rake
-    $ rake install
+    $ gem install dtc_rake
 
 # Quick Start
 
@@ -28,14 +26,14 @@ For a quick start just add to your appbox project's `Rakefile`:
 require "dtc_rake"
 
 DtcRake.configure do |config|
-  config.appbox_uarchive = "<uarchive_path>"
+  config.product_code = "<product_code>"
+  config.product_name = "<product_name>"
   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`.*
+*Note: The appbox project name should be `<vendor>_<app>-appbox`. If not, you must specify `config.vendor` and `config.app` within `DtcRake.configure` in `Rakefile`.*
 
 All shared tasks will be found and loaded automatically, you can verify it with `rake -T` command.
 
@@ -61,7 +59,6 @@ rake upload:cmd DTC_RAKE_PASSWD=/path/to/12-345-6
 
 The following example shows all configuration options:
 
-
 ```ruby
 require "dtc_rake"
 
@@ -70,7 +67,7 @@ DtcRake.configure do |config|
   config.app = "<app_code>"
 
   # Code of appbox artifact. Guessed from vendor, app and version in uuApp
-  # deployment descriptor if not set.
+  # deployment descriptor if not set. Since 0.2.0.
   config.appbox_artifact_code = "<artifact_code>"
 
   # Code of appbox location (folder or organization unit). Required.
@@ -86,9 +83,10 @@ DtcRake.configure do |config|
   # 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>"
+  
+  # Appbox version. Read from VERSION file located in the same directory
+  # as Rakefile if not set.
+  config.appbox_version = "1.2.3-dev"
 
   # Print messages in colors. Default value: true.
   config.colorize = true
@@ -97,17 +95,64 @@ DtcRake.configure do |config|
   # Relative path is relative to root_dir.
   config.output_dir = "target"
 
+  # Code of product the appbox belongs to. Required.
+  config.product_code = "UU-CLOUDG01-C3"
+
+  # Name of product the appbox belongs to. Required.
+  config.product_name = "uuCloudg01C3"
+
   # 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
+  # Upload README.md or README.txt to appbox artifact. Default value: false.
+  config.upload_readme = true
+
+  # Upload uuCloud deployment descriptor to appbox artifact. Default value: false.
+  config.upload_uucloud_descriptor = true
+
+  # Path to uuCloud deployment descriptor. Default value: uucloud_descriptor.json.
+  config.uucloud_descriptor_path = "<uucloud_descriptor_path>"
 
   # Code of vendor. Guessed from root_dir name if not set.
   config.vendor = "<vendor_code>"
+  
+  # List of files (or glob patterns) determining which files get updated by
+  # version:sync task. Default: none.
+  config.version_sync_files = ["../uu_c3/lib/uu_c3/version.rb"]
 end
 ```
 
+`VERSION` file contents example:
+
+```
+1.2.3-dev
+```
+
+*Note: Leading and trailing whitespace (incl. line breaks) does not matter - it gets stripped/trimmed. Only the version itself is important.*
+
+### Environment Variables
+
+Configuration can also be specified in environment variables. Environment variables take precedence over configuration in `Rakefile`.
+
+```
+  DTC_RAKE_APP=<app_code>
+  DTC_RAKE_APPBOX_ARTIFACT_CODE=<artifact_code>
+  DTC_RAKE_APPBOX_LOCATION_CODE=<folder_code>
+  DTC_RAKE_APPBOX_META_ARTIFACT_CODE=<meta_artifact_code>
+  DTC_RAKE_APPBOX_TERRITORY_CODE=<territory_code>
+  DTC_RAKE_APPBOX_UARCHIVE=<uarchive_path>
+  DTC_RAKE_APPBOX_VERSION=1.2.3-dev
+  DTC_RAKE_COLORIZE=false
+  DTC_RAKE_OUTPUT_DIR=target
+  DTC_RAKE_PRODUCT_CODE=UU-CLOUDG01-C3
+  DTC_RAKE_PRODUCT_NAME=uuCloudg01C3
+  DTC_RAKE_ROOT_DIR=<root_dir>
+  DTC_RAKE_UPLOAD_README=true
+  DTC_RAKE_UPLOAD_UUCLOUD_DESCRIPTOR=true
+  DTC_RAKE_UUCLOUD_DESCRIPTOR_PATH=<uucloud_descriptor_path>
+  DTC_RAKE_VENDOR=<vendor_code>
+```
+
 ## Explanation of Provided Tasks
 
 ### appbox
@@ -136,7 +181,7 @@ Builds pack with command server. Available if project `<vendor>_<app>-cmd` exist
 
 ### build:dockerfiles
 
-Builds pack with `Dockerfile`s. Available if project `<vendor>_<app>-dockerfiles` exists.
+Builds pack with `Dockerfile`s. Available if project `docker` exists.
 
 ### build:gem
 
@@ -148,7 +193,7 @@ Builds pack with visual use cases. Available if project `<vendor>_<app>-vuc` exi
 
 ### build:yardoc
 
-Builds pach with command client yardoc. Available if project `<vendor>_<app>` exists.
+Builds pack with command client yardoc. Available if project `<vendor>_<app>` exists.
 
 ### upload:all
 
@@ -162,13 +207,13 @@ 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`.
+Uploads uuApp deployment descriptor to appbox artifact. Available if `config.upload_uucloud_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.
+Uploads pack with `Dockerfile`s to appbox artifact. Available if project `docker` exists.
 
 Requires `DTC_RAKE_PASSWD` to be set.
 
@@ -186,10 +231,30 @@ Requires `DTC_RAKE_PASSWD` to be set.
 
 ### upload:yardoc
 
-Uploads pach with command client yardoc to appbox artifact. Available if project `<vendor>_<app>` exists.
+Uploads pack with command client yardoc to appbox artifact. Available if project `<vendor>_<app>` exists.
 
 Requires `DTC_RAKE_PASSWD` to be set.
 
+### version
+
+Shows the current version stored in `VERSION` file located in the same directory as `Rakefile`.
+
+### version:bump:major
+
+Bumps the major version. Updates `VERSION` file located in the same directory as `Rakefile` and files specified in `config.version_files`.
+
+### version:bump:minor
+
+Bumps the minor version. Updates `VERSION` file located in the same directory as `Rakefile` and files specified in `config.version_files`.
+
+### version:bump:patch
+
+Bumps the patch version. Updates `VERSION` file located in the same directory as `Rakefile` and files specified in `config.version_files`.
+
+### version:set
+
+Sets the version. The version may contain *prerelease* and/or *build metadata* parts (see [Semantic Versioning](http://semver.org)). Updates `VERSION` file located in the same directory as `Rakefile` and files specified in `config.version_files`.
+
 # How-to
 
 ## How to Add Custom Task
@@ -218,13 +283,6 @@ 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"])

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
 task :default => :build
+
+require "rake-version"
+RakeVersion::Tasks.new do |v|
+  v.copy "lib/dtc_rake/version.rb"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0-beta.1

data/dtc_rake.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rainbow", "~> 2.1.0"
   spec.add_runtime_dependency "uu_os", "~> 0.19"
   spec.add_runtime_dependency "uu_os_commons", "~> 1.5"
+  spec.add_runtime_dependency "rake-version", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.13", ">= 1.13.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 11.0"
 end

data/lib/dtc_rake/config.rb

@@ -3,7 +3,9 @@ require "pathname"
 
 module DtcRake
   def configure(&block)
-    yield Config.instance
+    config = Config.instance
+    yield config
+    config.validate!
   end
   module_function :configure
 
@@ -11,19 +13,21 @@ module DtcRake
     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
+      self.root_dir   = Dir.pwd
+      self.output_dir = "target"
+      self.colorize   = true
+      self.upload_readme = false
+      self.appbox_meta_artifact_code = "UU.OS/RUNTIME/APP_BOX"
+      self.upload_uucloud_descriptor = false
+      self.version_files = []
       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.
+    # Code of appbox artifact. Guessed from product_code and appbox_version
+    # if not set.
     attr_accessor :appbox_artifact_code
 
     # Code of appbox location (folder or organization unit). Required.
@@ -40,8 +44,9 @@ module DtcRake
     # 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
+    # Appbox version. Read from VERSION file located in the same directory
+    # as Rakefile if not set.
+    attr_accessor :appbox_version
 
     # Print messages in colors. Default value: true.
     attr_accessor :colorize
@@ -50,45 +55,302 @@ module DtcRake
     # Relative path is relative to root_dir.
     attr_accessor :output_dir
 
+    # Code of product the appbox belongs to. Required.
+    attr_accessor :product_code
+
+    # Name of product the appbox belongs to. Required.
+    attr_accessor :product_name
+
     # Appbox project root folder. Default value: current working directory.
     attr_accessor :root_dir
 
+    # Upload README.md or README.txt to appbox artifact. Default value: false.
+    attr_accessor :upload_readme
+
     # Upload uuApp deployment descriptor to appbox artifact. Default value: false.
-    attr_accessor :upload_app_descriptor
+    attr_accessor :upload_uucloud_descriptor
+
+    # Path to uuApp deployment descriptor. Default value: uucloud_descriptor.json.
+    attr_accessor :uucloud_descriptor_path
 
     # Code of vendor. Guessed from root_dir name if not set.
     attr_accessor :vendor
 
+    # List of files (or glob patterns) determining which files get updated by
+    # version:* tasks. Default: none.
+    attr_accessor :version_files
+
+    def validate!
+      %w(appbox_location_code appbox_territory_code product_code product_name).each do |param|
+        if instance_variable_get("@#{param}").nil?
+          _error "Required parameter #{param} is not set. Set it within DtcRake.configure in your Rakefile."
+        end
+      end
+    end
+
     def app=(name)
       @app = name.downcase unless name.nil?
     end
 
+    def appbox_artifact_code
+      return @appbox_artifact_code if @appbox_artifact_code
+
+      @appbox_artifact_code = ENV["DTC_RAKE_APPBOX_ARTIFACT_CODE"]
+
+      if @appbox_artifact_code.nil?
+        default_code = "#{product_code}/APPBOX-#{appbox_version}"
+        @appbox_artifact_code = default_code
+      end
+
+      @appbox_artifact_code
+    end
+
+    def appbox_artifact_code=(code)
+      env = ENV["DTC_RAKE_APPBOX_ARTIFACT_CODE"]
+      # environment variable takes precedence
+      @appbox_artifact_code = env.nil? ? code : env
+      @appbox_artifact_code
+    end
+
+    def appbox_location_code
+      return @appbox_location_code if @appbox_location_code
+
+      @appbox_location_code = ENV["DTC_RAKE_APPBOX_LOCATION_CODE"]
+      @appbox_location_code
+    end
+
+    def appbox_location_code=(code)
+      env = ENV["DTC_RAKE_APPBOX_LOCATION_CODE"]
+      # environment variable takes precedence
+      @appbox_location_code = env.nil? ? code : env
+      @appbox_location_code
+    end
+
+    def appbox_meta_artifact_code
+      return @appbox_meta_artifact_code if @appbox_meta_artifact_code
+
+      @appbox_meta_artifact_code = ENV["DTC_RAKE_APPBOX_META_ARTIFACT_CODE"]
+      @appbox_meta_artifact_code
+    end
+
+    def appbox_meta_artifact_code=(code)
+      env = ENV["DTC_RAKE_APPBOX_META_ARTIFACT_CODE"]
+      # environment variable takes precedence
+      @appbox_meta_artifact_code = env.nil? ? code : env
+      @appbox_meta_artifact_code
+    end
+
+    def appbox_territory_code
+      return @appbox_territory_code if @appbox_territory_code
+
+      @appbox_territory_code = ENV["DTC_RAKE_APPBOX_TERRITORY_CODE"]
+      @appbox_territory_code
+    end
+
+    def appbox_territory_code=(code)
+      env = ENV["DTC_RAKE_APPBOX_TERRITORY_CODE"]
+      # environment variable takes precedence
+      @appbox_territory_code = env.nil? ? code : env
+      @appbox_territory_code
+    end
+
+    def appbox_uarchive
+      return @appbox_uarchive if @appbox_uarchive
+
+      @appbox_uarchive = ENV["DTC_RAKE_APPBOX_UARCHIVE"]
+      @appbox_uarchive
+    end
+
     def appbox_uarchive=(path)
+      env = ENV["DTC_RAKE_APPBOX_UARCHIVE"]
+      # environment variable takes precedence
+      path = env unless env.nil?
+
       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)
+        path = File.expand_path(path)
+
+        if Pathname.new(path).relative?
+          @appbox_uarchive = File.join(root_dir, path)
+        else
+          @appbox_uarchive = path
+        end
       end
     end
 
-    def app_descriptor_path
-      return @app_descriptor_path if @app_descriptor_path
+    def appbox_version
+      return @appbox_version if @appbox_version
 
-      default_file_path = File.expand_path(File.join(root_dir, "#{vendor}_#{app}-uuapp-deploy.json"))
+      @appbox_version = ENV["DTC_RAKE_APPBOX_VERSION"]
 
-      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."
+      if @appbox_version.nil?
+        version_file = File.join(root_dir, 'VERSION')
+        unless File.file?(version_file)
+          _error "Unknown appbox version. Set it in #{version_file} file or DTC_RAKE_APPBOX_VERSION environment variable."
         end
-        @app_descriptor_path = default_file_path
+        version = File.binread(version_file).strip
+        @appbox_version = version
+      end
+    end
+
+    def appbox_version=(code)
+      env = ENV["DTC_RAKE_APPBOX_VERSION"]
+      # environment variable takes precedence
+      @appbox_version = env.nil? ? code : env
+      @appbox_version
+    end
+
+    def colorize
+      return @colorize if @colorize
+
+      env = ENV["DTC_RAKE_COLORIZE"]
+      unless env.nil?
+        @colorize = to_bool(env)
       end
+      @colorize
+    end
+
+    def colorize=(flag)
+      env = ENV["DTC_RAKE_COLORIZE"]
+      # environment variable takes precedence
+      if env.nil?
+        @colorize = flag
+      else
+        @colorize = to_bool(env)
+      end
+      @colorize
+    end
+
+    def output_dir
+      return @output_dir if @output_dir
+
+      @output_dir = ENV["DTC_RAKE_OUTPUT_DIR"]
+      @output_dir
     end
 
     def output_dir=(path)
+      env = ENV["DTC_RAKE_OUTPUT_DIR"]
+      # environment variable takes precedence
+      path = env unless env.nil?
+
+      unless path.nil?
+        # File.expand_path converts path to absolute and expands "~" to real user home path
+        path = File.expand_path(path)
+
+        if Pathname.new(path).relative?
+          @output_dir = File.join(root_dir, path)
+        else
+          @output_dir = path
+        end
+      end
+    end
+
+    def product_code
+      return @product_code if @product_code
+
+      @product_code = ENV["DTC_RAKE_PRODUCT_CODE"]
+      @product_code
+    end
+
+    def product_code=(code)
+      env = ENV["DTC_RAKE_PRODUCT_CODE"]
+      # environment variable takes precedence
+      @product_code = env.nil? ? code : env
+      @product_code
+    end
+
+    def product_name
+      return @product_name if @product_name
+
+      @product_name = ENV["DTC_RAKE_PRODUCT_NAME"]
+      @product_name
+    end
+
+    def product_name=(name)
+      env = ENV["DTC_RAKE_PRODUCT_NAME"]
+      # environment variable takes precedence
+      @product_name = env.nil? ? name : env
+      @product_name
+    end
+
+    def root_dir
+      return @root_dir if @root_dir
+
+      @root_dir = ENV["DTC_RAKE_ROOT_DIR"]
+      @root_dir = Dir.pwd if @root_dir.nil?
+
+      @root_dir
+    end
+
+    def root_dir=(path)
+      env = ENV["DTC_RAKE_ROOT_DIR"]
+      # environment variable takes precedence
+      path = env unless env.nil?
+
       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)
+        # If the path is relative, it gets evaluated against to current working directory (Dir.pwd)
+        @root_dir = File.expand_path(path)
+      end
+    end
+
+    def upload_readme
+      return @upload_readme if @upload_readme
+
+      @upload_readme = to_bool(ENV["DTC_RAKE_UPLOAD_README"])
+      @upload_readme
+    end
+
+    def upload_readme=(flag)
+      env = ENV["DTC_RAKE_UPLOAD_README"]
+      # environment variable takes precedence
+      if env.nil?
+        @upload_readme = flag
+      else
+        @upload_readme = to_bool(env)
+      end
+      @upload_readme
+    end
+
+    def upload_uucloud_descriptor
+      return @upload_uucloud_descriptor if @upload_uucloud_descriptor
+
+      @upload_uucloud_descriptor = to_bool(ENV["DTC_RAKE_UPLOAD_UUCLOUD_DESCRIPTOR"])
+      @upload_uucloud_descriptor
+    end
+
+    def upload_uucloud_descriptor=(flag)
+      env = ENV["DTC_RAKE_UPLOAD_UUCLOUD_DESCRIPTOR"]
+      # environment variable takes precedence
+      if env.nil?
+        @upload_uucloud_descriptor = flag
+      else
+        @upload_uucloud_descriptor = to_bool(env)
+      end
+      @upload_uucloud_descriptor
+    end
+
+    def uucloud_descriptor_path
+      return @uucloud_descriptor_path if @uucloud_descriptor_path
+
+      env = ENV["DTC_RAKE_UUCLOUD_DESCRIPTOR_PATH"]
+      if env.nil?
+        default_file_path = File.expand_path(File.join(root_dir, "uucloud_descriptor.json"))
+
+        Dir.chdir(root_dir) do
+          unless File.file?(default_file_path)
+            _error "uuCloud deployment descriptor not found. Please create file #{default_file_path} or configure its path in Rakefile." \
+              " Or you can configure its path in DTC_RAKE_UUCLOUD_DESCRIPTOR_PATH environment variable."
+          end
+          @uucloud_descriptor_path = default_file_path
+        end
+      else
+        env = File.expand_path(env)
+        unless File.file?(env)
+          _error "uuCloud deployment descriptor not found. Please create file #{env} or configure its path in" \
+            " DTC_RAKE_UUCLOUD_DESCRIPTOR_PATH environment variable."
+        end
+        @uucloud_descriptor_path = env
       end
     end
 
@@ -96,17 +358,48 @@ module DtcRake
       @vendor = name.downcase unless name.nil?
     end
 
+    def version_files=(list)
+      if list.nil?
+        @version_files = []
+      elsif list.is_a?(Array)
+        @version_files = list
+      else
+        _error "Invalid version_files value - #{list} (#{list})." \
+          " Use an array of strings (representing file names or glob patterns)."
+      end
+    end
+
     private
 
+    def to_bool(value)
+      (value =~ /^true|1|yes$/i) == 0
+    end
+
     def guess_vendor_and_app
-      base_name = File.basename(root_dir)
-      if /([^_]+)_([^-]+)-appbox/ =~ base_name
-        @vendor = $1
-        @app = $2
+      env_vendor = ENV["DTC_RAKE_VENDOR"]
+      env_app = ENV["DTC_RAKE_APP"]
+
+      if env_vendor.nil? || env_app.nil?
+        base_name = File.basename(root_dir)
+        if /([^_]+)_([^-]+)-appbox/ =~ base_name
+          @vendor = env_vendor.nil? ? $1 : env_vendor
+          @app = env_app.nil? ? $2 : env_app
+        else
+          _error "Appbox root folder (#{base_name}) does not match naming convention <vendor>_<app>-appbox." \
+          " Either change the folder name or configure 'vendor' and 'app' within DtcRake.configure in Rakefile." \
+          " Or you can set DTC_RAKE_VENDOR and DTC_RAKE_APP environment variables to specify those."
+        end
       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."
+        @vendor = env_vendor
+        @app = env_app
       end
     end
+
+    def _error(msg)
+      # this avoids cycle between dtc_rake/config and dtc_rake/ui
+      require "dtc_rake/ui"
+      self.class.send(:include, DtcRake::UI) unless self.class.include?(DtcRake::UI)
+      error(msg)
+    end
   end
 end

data/lib/dtc_rake/product.rb

@@ -40,55 +40,51 @@ module DtcRake
       @has_dockerfiles = File.directory?(@dockerfiles_project)
     end
 
-    def app_descriptor
-      return @app_descriptor if @app_descriptor
+    def uucloud_descriptor
+      return @uucloud_descriptor if @uucloud_descriptor
 
-      File.open(Config.instance.app_descriptor_path, "r") do |f|
-        @app_descriptor = JSON.parse(f.read, symbolize_names: true)
+      # TODO: Use app.json instead of uucloud_descriptor.json for appbox metadata
+      File.open(Config.instance.uucloud_descriptor_path, "r") do |f|
+        @uucloud_descriptor = JSON.parse(f.read, symbolize_names: true)
       end
     end
 
     def version
-      app_descriptor[:data][:version]
+      config = Config.instance
+      config.appbox_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 = UU::OS::UESURI.create(territory_code: config.appbox_territory_code, artifact_code: config.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_version = version.sub(/-(dev|ALPHA|BETA|RC)/) { |_| ".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
 
@@ -128,10 +124,16 @@ module DtcRake
       @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
+    def uucloud_descriptor_attachment_code
+      return @uucloud_descriptor_attachment_code if defined? @uucloud_descriptor_attachment_code
+      config = Config.instance
+      @uucloud_descriptor_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/UUAPP-DEPLOY"
+    end
+
+    def readme_attachment_code
+      return @readme_attachment_code if defined? @readme_attachment_code
       config = Config.instance
-      @app_descriptor_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/UUAPP-DEPLOY"
+      @readme_attachment_code = "#{config.vendor.upcase}.#{config.app.upcase}/README"
     end
   end
 end

data/lib/dtc_rake/ui.rb

@@ -1,37 +1,45 @@
 module DtcRake
   module UI
     def error(msg)
-      msg = Rainbow(msg).red if colorize?
+      if DtcRake::UI.colorize?
+        msg = Rainbow(msg).red
+      end
       abort msg
     end
     module_function :error
 
     def announce(msg)
-      msg = Rainbow(msg).aqua if colorize?
+      if DtcRake::UI.colorize?
+        msg = Rainbow(msg).aqua
+      end
       puts msg
     end
     module_function :announce
 
     def success(msg)
-      msg = Rainbow(msg).green if colorize?
+      if DtcRake::UI.colorize?
+        msg = Rainbow(msg).green
+      end
       puts msg
     end
     module_function :success
 
     def warning(msg)
-      msg = Rainbow(msg).yellow if colorize?
+      if DtcRake::UI.colorize?
+        msg = Rainbow(msg).yellow
+      end
       puts msg
     end
     module_function :warning
 
     def info(msg)
-      msg = Rainbow(msg).white if colorize?
+      if DtcRake::UI.colorize?
+        msg = Rainbow(msg).white
+      end
       puts msg
     end
     module_function :info
 
-    private
-
     def colorize?
       return @colorize if defined? @colorize
 
@@ -45,5 +53,6 @@ module DtcRake
       end
       @colorize = colorize
     end
+    module_function :colorize?
   end
 end

data/lib/dtc_rake/version.rb

@@ -1,3 +1,3 @@
 module DtcRake
-  VERSION = "0.2.0"
+  VERSION = "1.0.0-beta.1"
 end

data/lib/tasks/appbox.rake

@@ -5,6 +5,8 @@ require "dtc_rake/product"
 require "dtc_rake/ui"
 
 require "uu/os/security/session"
+require "uu/os/uesuri"
+require "uu/os/search"
 require "uu/os/artifact"
 require "uu/os/sheet"
 require "uu/os/rest/binary_value"
@@ -24,7 +26,7 @@ def create_appbox(attrs)
   config = DtcRake::Config.instance
   product = DtcRake::Product.instance
   credentials = attrs[:credentials]
-  version = attrs.fetch(:version, product.version)
+  version = attrs.fetch(:version, config.appbox_version)
   icon = attrs.fetch(:icon, %q(ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{ART_364}))
 
   error("Specify appbox location code - set it in DtcRake.configure block (attribute appbox_location_code) in your Rakefile") unless config.appbox_location_code
@@ -37,8 +39,15 @@ def create_appbox(attrs)
   UU::OS::Security::Session.login(credentials)
 
   config = DtcRake::Config.instance
-  art_name = "#{product.app_descriptor[:data][:name]} #{version}"
-  art_code = config.appbox_artifact_code || "#{product.app_descriptor[:data][:code]}_#{version}"
+  art_name = "#{config.product_name} #{version} AppBox"
+  art_code = config.appbox_artifact_code
+
+  art_uri = UU::OS::UESURI.create(territory_code: config.appbox_territory_code, artifact_code: art_code)
+  if UU::OS::Search.exists(art_uri)
+    info "Appbox #{art_uri} already exists"
+    return
+  end
+
   announce "Creating appbox #{art_code} in territory #{config.appbox_territory_code}"
 
   appbox_uri = UU::OS::Artifact.create(location,
@@ -86,5 +95,5 @@ task :appbox do
     credentials: ENV["DTC_RAKE_PASSWD"],
     version: ENV["VERSION"] || DtcRake::Product.instance.version
   )
-  success "Appbox #{art_uri} created"
+  success "Appbox #{art_uri} created" unless art_uri.nil?
 end

data/lib/tasks/upload_all.rake

@@ -14,7 +14,8 @@ end
 deps << :cmd         if product.has_cmd
 deps << :vuc         if product.has_vuc
 deps << :dockerfiles if product.has_dockerfiles
-deps << :descriptor  if config.upload_app_descriptor
+deps << :descriptor  if config.upload_uucloud_descriptor
+deps << :readme      if config.upload_readme
 
 namespace :upload do
   desc "Uploads all packs to appbox artifact; requires path to password file"

data/lib/tasks/upload_descriptor.rake

@@ -9,10 +9,10 @@ include DtcRake::UI
 product = DtcRake::Product.instance
 config = DtcRake::Config.instance
 
-if config.upload_app_descriptor
+if config.upload_uucloud_descriptor
   namespace :upload do
     desc <<-DESC.gsub(/^ {4}/, '')
-      Uploads uuApp deployment descriptor to appbox artifact; requires path to password file.
+      Uploads uuCloud deployment descriptor to appbox artifact; requires path to password file.
 
       rake upload:descriptor DTC_RAKE_PASSWD=12-345-6
       ("~/.uu/12-345-6" will be used)
@@ -23,11 +23,11 @@ if config.upload_app_descriptor
     task :descriptor do
       error("Specify password file in env variable DTC_RAKE_PASSWD, e.g. rake upload:descriptor DTC_RAKE_PASSWD=12-345-6") unless ENV["DTC_RAKE_PASSWD"]
 
-      the_file = config.app_descriptor_path
+      the_file = config.uucloud_descriptor_path
       error("File #{the_file} does not exist") unless File.file?(the_file)
 
       art_uri = product.appbox_uri
-      attch_code = product.app_descriptor_attachment_code
+      attch_code = product.uucloud_descriptor_attachment_code
       announce "Uploading #{the_file} to #{art_uri}:#{attch_code}..."
       attch_uri = DtcRake.upload_pack(
         file: the_file,

data/lib/tasks/upload_readme.rake

@@ -0,0 +1,47 @@
+require "rake"
+require "fileutils"
+require "dtc_rake/config"
+require "dtc_rake/product"
+require "dtc_rake/ui"
+require "dtc_rake/util"
+
+include DtcRake::UI
+product = DtcRake::Product.instance
+config = DtcRake::Config.instance
+
+if config.upload_readme
+  namespace :upload do
+    desc <<-DESC.gsub(/^ {4}/, '')
+      Uploads README.md or README.txt to appbox artifact; requires path to password file.
+
+      rake upload:readme DTC_RAKE_PASSWD=12-345-6
+      ("~/.uu/12-345-6" will be used)
+
+      rake upload:readme DTC_RAKE_PASSWD=/path/to/12-345-6
+      (password file from the specified path will be used)
+    DESC
+    task :readme do
+      error("Specify password file in env variable DTC_RAKE_PASSWD, e.g. rake upload:readme DTC_RAKE_PASSWD=12-345-6") unless ENV["DTC_RAKE_PASSWD"]
+
+      readme_dir = File.expand_path(File.join(config.root_dir, ".."))
+      readme = File.join(readme_dir, "README.md")
+      unless File.file?(readme)
+        readme = File.join(readme_dir, "README.txt")
+        unless File.file?(readme)
+          error("Neither README.md nor README.txt found in #{readme_dir}")
+        end
+      end
+
+      art_uri = product.appbox_uri
+      attch_code = product.readme_attachment_code
+      announce "Uploading #{readme} to #{art_uri}:#{attch_code}..."
+      attch_uri = DtcRake.upload_pack(
+        file: readme,
+        appbox_uri: art_uri,
+        attachment_code: attch_code,
+        credentials: ENV["DTC_RAKE_PASSWD"]
+      )
+      success "File #{readme} uploaded to #{attch_uri}"
+    end
+  end
+end

data/lib/tasks/version.rake

@@ -0,0 +1,17 @@
+begin
+  require "rake-version"
+rescue LoadError => e
+  abort "WARNING: Failed to load rake-version gem - cause: #{e.message}.\n" \
+    "\tYou won't be able to manipulate with version via Rake tasks until you resolve the problem."
+end
+
+require "rake"
+require "dtc_rake/config"
+require "dtc_rake/ui"
+
+include DtcRake::UI
+config = DtcRake::Config.instance
+
+RakeVersion::Tasks.new do |v|
+  v.copy *config.version_files, all: true
+end

metadata

@@ -1,116 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: dtc_rake
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0.pre.beta.1
 platform: ruby
 authors:
 - Jan Sibil
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.3
-  type: :runtime
+  name: json
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.0
-  type: :runtime
+  name: rainbow
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: uu_os
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.19'
-  type: :runtime
+  name: uu_os
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: uu_os_commons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  type: :runtime
+  name: uu_os_commons
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: rake-version
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.13.3
-  type: :development
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.13.3
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '11.0'
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '11.0'
+description:
 email:
 - 21-1@plus4u.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - README.md
 - Rakefile
+- VERSION
 - bin/console
 - bin/setup
 - dtc_rake.gemspec
@@ -133,29 +148,31 @@ files:
 - lib/tasks/upload_descriptor.rake
 - lib/tasks/upload_dockerfiles.rake
 - lib/tasks/upload_gem.rake
+- lib/tasks/upload_readme.rake
 - lib/tasks/upload_vuc.rake
 - lib/tasks/upload_yardoc.rake
-homepage: 
+- lib/tasks/version.rake
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
 specification_version: 4
 summary: Rake tasks for building apps produced by DTC.DEV team.
 test_files: []