dtk-client 0.7.10 → 0.8.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDI3ZWM5ZTI4MWM1Njg2NDU4ZmUzYjgyNzQxZjljMDQwMzM4Yjc3Nw==
-  data.tar.gz: !binary |-
-    NzcwNjY1YmQxNTFhNWNjMzM1Y2E5NDQ3ZTgxMDI2YjUwOWI5ZTI2Yw==
+SHA1:
+  metadata.gz: 8bab62a8bff9a56a5888fb17f4128a69891786d0
+  data.tar.gz: 1ead8b18d171036edbf6f0633f4da99355b00f07
 SHA512:
-  metadata.gz: !binary |-
-    NDNiY2Y2ZWRhMjQ4MzdlZjQ4MjZkMTIzNWJkMzNkMTJjOTYyNGM5NjY1NTQ1
-    ZWQ1YjRhY2YzNzNhYTQ0MGM4OWZhNmIzZThhYTM0ODY4Njk4ZTBlZWY1MWIy
-    NjcyYzZlMjYxM2JlNzE2ZjQ2MjM3ZDNiZDg2ZTVjZmQzYTg1ODE=
-  data.tar.gz: !binary |-
-    NmIwOTNkODgyMTllNmE0ODRkY2IyNmRhZDIyYTc0NDFiYmE1YzE5Nzc4YTY0
-    ZTY2ZGNkOWNmMGE3MmY5OGEwZTBlZWMzNzE0NTIxYjljYTAyM2U1N2QwYWI2
-    MzA4ZTFlMGI1MTRmYTQ0MzI1MGUwMTA3YTIwMWYwYzhjMzYwOTY=
+  metadata.gz: 11804a4fc9c39c49616b048eaa7a8229b7f0e7a0abeae8a49e9cbaab2bec8e618befe267533ba671473f1c38116381e31a3a00056a2e67945be41034bf0bb456
+  data.tar.gz: 796071c75b5dce8c4377d849f8a955ae2ca5b8a4c67958f604c52edafe4201b9b3f3257f01a53aa68c3e256aba425f0eff86cb845cc64f35e2321ab3e62f2542

data/README.md

@@ -1,78 +1,112 @@
-DTK Client installation
+DTK Client
 ==============================
 
-To install DTK Client, follow these steps
 
-- Ruby installation is required (verions 1.8.7 and newer are supported)
-- Git is required for all features to work ([install instructions](http://git-scm.com/book/en/Getting-Started-Installing-Git))
-- Install the dtk-client gem:  
-`gem install dtk-client`
+#### Description
 
-- Type <tt>dtk</tt> or <tt>dtk-shell</tt> to start using the client  
-On the first run, Client will present you with a wizard to enter your server and authentication info.
 
-DEVELOPMENT SETUP - DTK Client
-==============================
+DTK Client is a Ruby based CLI interface for communication with the DTK Server.
+It's main purpose is to provide an easy to use interface for importing modules, browsing modules repository and deploying assemblies and topologies.
 
-Pre-requisites
-----------------------
+---
+#### Sytstem requirements
 
-- Make sure you are using Ruby 1.8.7 , use following command to check ruby version <tt>ruby -v</tt>
+- Ruby 1.9.3 
+- Unix OS
 
-Git setup
-----------------------
+---
+#### Installation 
 
-- Make sure that you have clone dtk-common in same folder, use: 
+For DTK Client to work, following steps have to be done:
 
-```
-git clone git@github.com:rich-reactor8/dtk-common.git dtk-common 
-```
+- Git User set up
+- RSA Keys Generated
 
-Make sure that in same folder you have cloned dtk-common project. Also that project is under the same name.
+To install DTK Client gem, execute:
+ 
+`gem install dtk-client`
 
-Gem Setup
-----------------------
+---
+#### Initial setup
 
-- Make sure that you have bundler gem, check with <tt>gem list bundler</tt>
-- If you don't have it install bundler gem <tt>gem install bundler</tt>
-- Run bundle from dtk-client folder <tt>bundle install</tt>
+There are two ways for DTK Client to run
 
-Path Setup
-----------------------
+- via an interactive shell (<tt>dtk-shell</tt>)
+- by executing DTK Client commands (ie. <tt>dtk service list</tt>)
 
-- Add dtk-client to PATH e.g.
+If it is the first time that the DTK Client is being used (by either of the ways), following prompts will appear: 
 
 ```
-export PATH=$PATH:/home/user/dtk-client/bin
-```
+Please enter the DTK server address (example: instance.dtk.io)
+Server address:
 
-Development configuration setup
-----------------------
+Please enter your DTK login details
+Username:
+Password:
 
-- Copy `default.conf` from `lib/config`
-- Rename copied file to `local.conf` and place it in `lib/config`
-- Set configuration at will, local configuration is git ignored
+```
+After entering the correct data, following message will appear:
+ 
+`SSH key 'dtk-client' added successfully!`
+
+This means that the DTK Server has successfully registered DTK Client and the client is ready for use. 
 
-NOTE: There is client configuration which can be found in `~/dtk/client.conf`. Local configuration takes presedence over any other configuration.
+---
+#### DTK Client configuration
 
-Configuration Setup
-----------------------
+All of the DTK Configuration, installed component and service modules as well as client logs are located in `~/dtk`.
 
-- Create file <tt>~dtkconfig</tt> in you dtk dir (~/dtk) e.g. home/foo-user/dtk/connection.conf
-  there you will define user credentials e.g.
+DTK Client configuration options, such as development option, verbose calls to DTK Server, log options and Client user credentials, can be configured in `~/dtk/client.conf`:
 
 ```
-username=abh
-password=r8server
-server_host=ec2-54-247-191-95.eu-west-1.compute.amazonaws.com
+debug_task_frequency=5            # assembly - frequency between requests (seconds)
+auto_commit_changes=false         # autocommit for modules
+verbose_rest_calls=false          # logging of REST calls
+
+module_location=component_modules
+service_location=service_modules
+test_module_location=test_modules
+backups_location=backups
+
+
+server_port=80
+secure_connection_server_port=443
 secure_connection=true
+server_host=instance.dtk.io
 ```
-Run Tests
-----------------------
 
-- From dtk-client project root run <tt>rspec</tt>, this will run all unit tests
 
+User credentials are located in `~/dtk/.connection`
+
+Component and Service modules that are installed, or modules that are imported are located in `~/dtk/component_modules` and `~/dtk/service_modules/`
+
+---
+
+## Advanced features
+#### DTK Repoman
+
+DTK Repoman is a Git based repository for publishing and installing component modules and service modules. DTK Repoman has it's own users, known as catalog users. The inital setup should register the DTK Client to the Public Catalog users. 
+
+Successfully registered DTK Client on DTK Repoman enables execution of commands such as:
+
+`dtk service-module list --remote` - lists service moduels on remote visible to the catalog user
+
+`dtk component-module install namespace/component-module-name` - install component module 
+
+Switching from public user to a commercial user can be done with `dtk account set-catalog-credentials`. This will initate a prompt for catalog username and password
+
+## License
+
+dtk-client is copyright (C) 2010-2016 dtk contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License in the [LICENSE](LICENSE) file, or at:
+
+   http://www.apache.org/licenses/LICENSE-2.0
 
-License
-----------------------
-DTK Client is released under the GPLv3 license. Please see LICENSE for more details.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/dtk

@@ -1,4 +1,21 @@
 #!/usr/bin/env ruby
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 
 # GLOBAL IDENTIFIER
 $shell_mode = false
@@ -72,4 +89,4 @@ rescue DTK::Client::DtkError => e
   DtkLogger.instance.error(e.message, true)
 rescue Exception => e
   DtkLogger.instance.error_pp(e.message, e.backtrace)
-end
+end

data/bin/dtk-execute

@@ -1,4 +1,21 @@
 #!/usr/bin/env ruby
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 
 require File.expand_path('../lib/client', File.dirname(__FILE__))
 require File.expand_path('../lib/execute', File.dirname(__FILE__))
@@ -12,4 +29,4 @@ Configurator.check_config_exists
 conn = Session.get_connection()
 exit if validate_connection(conn)
 
-Execute::Script.execute()
+Execute::Script.execute()

data/bin/dtk-shell

@@ -1,4 +1,21 @@
 #!/usr/bin/env ruby
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require File.expand_path('../lib/shell', File.dirname(__FILE__))
 require File.expand_path('../lib/commands/thor/account', File.dirname(__FILE__))
 

data/dtk-client.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'hirb','~> 0.7.0'
   gem.add_dependency 'thor','~> 0.15.4'
   gem.add_dependency 'erubis','~> 2.7.0'
-  gem.add_dependency 'dtk-common-core','0.7.3'
+  gem.add_dependency 'dtk-common-core','0.8.0'
   gem.add_dependency 'git','1.2.9'
   gem.add_dependency 'colorize','~> 0.5.8'
   gem.add_dependency 'highline', '1.6.16'

data/lib/auxiliary.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK
   module Client
     module Auxiliary
@@ -41,4 +58,4 @@ module DTK
       end
     end
   end
-end
+end

data/lib/bundler_monkey_patch.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module Bundler
   module SharedHelpers
 

data/lib/client.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require 'rubygems'
 
 begin
@@ -38,6 +55,4 @@ begin
 rescue SystemExit, Interrupt
   #puts "DTK Client action canceled."
   exit(1)
-end
-
-
+end

data/lib/command_helper.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK; module Client
   module CommandHelperMixin
     def Helper(helper_class_name)
@@ -13,4 +30,4 @@ module DTK; module Client
   #TODO: make all commands helpers a subclass of this
   class CommandHelper              
   end
-end; end
+end; end

data/lib/command_helpers/git_repo/merge.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK; module Client; class CommandHelper
   class GitRepo
     class Merge
@@ -133,4 +150,4 @@ module DTK; module Client; class CommandHelper
 
     end
   end
-end; end; end
+end; end; end

data/lib/command_helpers/git_repo.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 # This code is predciated on assumption that they is only one local branch (with with documented exceptions)
 # so checkout branch is not done in most cases
 #TODO : make sure all functions that use local_repo_dir( inside pass in full_moudle_name, not just module_name
@@ -569,6 +586,4 @@ module DTK; module Client; class CommandHelper
       repo.repo_dir.gsub(Regexp.new("/$"),"").split("/").last
     end
   end; end
-end; end; end
-
-
+end; end; end

data/lib/command_helpers/jenkins_client/config_xml.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 #TODO: should haev separet file sfor each template
 require 'erubis'
 class DTK::Client::JenkinsClient
@@ -268,4 +285,4 @@ end
 eos
 
   end
-end
+end

data/lib/command_helpers/jenkins_client.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 # TODO: Marked for removal [Haris] - Do we need this?
 require 'jenkins-client'
 module DTK; module Client
@@ -86,7 +103,4 @@ module DTK; module Client
       end
     end
   end
-end; end
-
-
-
+end; end

data/lib/command_helpers/service_importer.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 dtk_require_from_base('configurator')
 module DTK::Client
   #
@@ -44,10 +61,8 @@ module DTK::Client
           version     = r_module['version']
           full_name   = (version && !version.eql?('master')) ? "#{module_name}(#{version})" : module_name
 
-          if r_module['frozen']
-            print "Not allowed to update frozen #{module_type.gsub('_', ' ')} '#{module_name}' version '#{version}' \n" unless hide_output
-            next
-          end
+          # No op for frozen modules
+          next if r_module['frozen']
 
           print "Pulling #{module_type.gsub('_',' ')} content for '#{full_name}' ... " unless hide_output
 
@@ -229,4 +244,4 @@ module DTK::Client
     end
 
   end
-end
+end

data/lib/command_helpers/service_link.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK; module Client; class CommandHelper
   class ServiceLink < self; class << self
     def post_body_with_id_keys(context_params,method_argument_names)
@@ -13,6 +30,4 @@ module DTK; module Client; class CommandHelper
     end
 
   end; end
-end; end; end
-
-
+end; end; end

data/lib/command_helpers/test_module_creator.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require 'fileutils'
 require 'erubis'
 
@@ -49,4 +66,4 @@ module DTK::Client
 			end
 		end
 	end
-end
+end

data/lib/commands/common/thor/access_control.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK::Client
   module AccessControlMixin
 
@@ -43,7 +60,7 @@ module DTK::Client
         end
 
         puts "How should we resolve these dependencies: "
-        input = ::DTK::Shell::InteractiveWizard.resolve_input("(A)ll / (M)ain Module / (N)one ", ['M','A','N'], true)
+        input = ::DTK::Shell::InteractiveWizard.text_input("(A)ll / (M)ain Module / (N)one ", true, /M|A|N/i)
         if 'N'.eql?(input)
           return nil
         else

data/lib/commands/common/thor/action_result_handler.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK
   module Client
     module ActionResultHandler

data/lib/commands/common/thor/assembly_template.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK::Client
   module AssemblyTemplateMixin
     def get_assembly_name(assembly_id)
@@ -72,4 +89,4 @@ module DTK::Client
        end
     end
   end
-end
+end