dtc_rake

Rake tasks for building apps produced by DTC.DEV team.

Installation

Add this line to your application's Gemfile:

gem "dtc_rake"

And then execute:

$ bundle

Or install it yourself as:

$ gem install dtc_rake

Quick Start

For a quick start just add to your appbox project's Rakefile:

require "dtc_rake"

DtcRake.configure do |config|
  config.product_code = "<product_code>"
  config.product_name = "<product_name>"
  config.appbox_territory_code = "<territory_code>"
  config.appbox_location_code = "<folder_code>"
end

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.

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:

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

Online yardoc

Configuration

The following example shows all configuration options:

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. Since 0.2.0.
  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>"

  # 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

  # Name of folder with build products. Default value: target.
  # 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 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

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 Dockerfiles. Available if project docker 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 pack 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.