dtk-shell 0.10.0

data/lib/violation.rb

@@ -0,0 +1,86 @@
+#
+# 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 Violation
+      dtk_require('violation/attribute')
+      dtk_require('violation/fix')
+      
+      # fix must be before the specific violations
+      dtk_require('violation/sub_classes')
+
+      def initialize(service_id, violation_hash)
+        @service_id  = service_id
+        @description = violation_hash['description']
+      end
+      private :initialize
+      
+      def self.fix_violations(service_id, violation_hash_array)
+        violation_objects = violation_hash_array.map { |violation_hash| Violation.create?(service_id, violation_hash) }.compact
+        if violation_objects.empty?
+          Fix::Result.ok
+        else
+          run_fix_wizard(violation_objects) 
+        end
+      end
+      
+      private
+      
+      def self.create?(service_id, violation_hash)
+        unless violation_type = violation_hash['type']
+          DtkLogger.error "No type in violation hash: #{violation_hash.inspect}"
+          return nil
+        end
+
+        case violation_type
+         when 'required_unset_attribute'
+          RequiredUnsetAttribute.new(service_id, violation_hash)
+         when 'illegal_attribute_value'
+          IllegalAttributeValue.new(service_id, violation_hash)
+         when 'invalid_credentials'
+          InvalidCredentials.new(service_id, violation_hash)
+         else
+          DtkLogger.error "untreated violation type '#{violation_type}'"
+          nil
+        end
+      end
+
+      def self.run_fix_wizard(violation_objects)
+        rerun_violation_check = false
+        violation_objects.each do |violation| 
+          result = run_and_repeat_when_error(violation)
+          return result if result.skip_all?
+          rerun_violation_check = true if result.rerun_violation_check?
+        end
+        rerun_violation_check ? Fix::Result.rerun_violation_check : Fix::Result.ok
+      end
+
+      def self.run_and_repeat_when_error(violation)
+        result = violation.get_input_and_apply_fix
+        if result.error? 
+          result.render_error_msg
+          run_and_repeat_when_error(violation) 
+        else
+          result
+        end
+      end
+
+    end
+  end
+end
+

data/lib/violation/attribute.rb

@@ -0,0 +1,76 @@
+#
+# 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
+  class Violation
+    # represents a component, node, or assembly attribute
+    class Attribute
+      def initialize(attribute_hash)
+        # ref is the only key that is guarenteed to be present
+        @ref          = attribute_hash['ref']
+        @datatype     = attribute_hash['datatype']
+        @hidden       = attribute_hash['hidden']
+        @legal_values = attribute_hash['legal_values']
+        @fix_text     = attribute_hash['fix_text'] 
+      end
+
+      def prompt_user_for_value
+        Shell::InteractiveWizard.prompt_user_for_value(fix_text)
+      end
+
+      # Returns error message if an error
+      def illegal_value?(value)
+        value_does_not_match_datatype?(value) or value_not_legal_type?(value)
+      end
+
+      def set_attribute(service_id, value)
+        post_body = {
+          :assembly_id => service_id,
+          :pattern     => @ref,
+          :value       => value
+        }
+        response = Session.post('assembly/set_attributes', post_body)
+        response.ok? ? Fix::Result.ok : Fix::Result.error
+      end
+
+      private
+      
+      def fix_text
+        @fix_text ||= "Enter value for attribute '#{@ref}'"
+      end
+
+      def value_does_not_match_datatype?(value)
+        if @datatype
+          # TODO: put in datatype test
+        end
+      end
+
+      LegalValueIdent = 2
+      def value_not_legal_type?(value)
+        return nil unless @legal_values and ! @legal_values.include?(value)
+        error_msg = "Illegal value; value must be one of:"
+        @legal_values.each do |legal_value|
+          error_msg << "\n#{' ' * LegalValueIdent}#{legal_value}"
+        end
+        error_msg
+      end
+      
+    end
+  end
+end
+
+

data/lib/violation/fix.rb

@@ -0,0 +1,26 @@
+#
+# 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
+  class Violation
+    module Fix
+      dtk_require('fix/result')
+      dtk_require('fix/set_attribute')
+    end
+  end
+end
+

data/lib/violation/fix/result.rb

@@ -0,0 +1,73 @@
+#
+# 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
+  class Violation
+    module Fix
+      class Result
+        dtk_require('result/error')
+
+        Types = [:ok, :error, :skip_current, :skip_all, :error, :rerun_violation_check]
+
+        def self.create(type, *args)
+          case type
+            when :error then Error.new(*args)
+            else new(type)
+          end
+        end
+
+        def initialize(type)
+          @type = type
+        end
+        private :initialize
+
+
+        def self.method_missing(method, *args)
+          is_type?(method) ? create(method, *args) : super
+        end
+        def self.respond_to?(method)
+          !!is_type?(method) 
+        end
+
+        def method_missing(method, *args)
+          if type = is_type_with_question_mark?(method)
+            type == @type
+          else
+            super
+          end
+        end
+        def respond_to?(method)
+          !!is_type_with_question_mark?(method)
+        end
+        
+        private
+
+        def self.is_type?(method)
+          Types.include?(method) ? method : nil
+        end
+
+        def is_type_with_question_mark?(method)
+          if method.to_s =~ /(^.+)[?]$/
+            type = $1.to_sym
+            self.class.is_type?(type)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/violation/fix/result/error.rb

@@ -0,0 +1,34 @@
+#
+# 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 Violation::Fix
+    class Result
+      class Error < self
+        def initialize(opts = {})
+          super(:error)
+          @error_msg = opts[:error_msg]
+        end
+
+        def render_error_msg
+          OsUtil.print(@error_msg, :red) if @error_msg
+        end
+      end
+    end
+  end
+end
+

data/lib/violation/fix/set_attribute.rb

@@ -0,0 +1,41 @@
+#
+# 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
+  class Violation
+    module Fix
+      module SetAttribute
+        def self.get_input_and_apply_fix(service_id, attribute)
+          prompt_response = attribute.prompt_user_for_value
+          if prompt_response.response_type == :skipped
+            # TODO: may distinguish between skip current and skip all; now treating everything as skip all
+            return Result.skip_all
+          end
+          
+          prompted_value = prompt_response.value
+          if error_msg = attribute.illegal_value?(prompted_value)
+            Result.error :error_msg => error_msg
+          else
+            attribute.set_attribute(service_id, prompted_value)
+          end
+        end
+   
+      end
+    end
+  end
+end
+

data/lib/violation/sub_classes.rb

@@ -0,0 +1,60 @@
+#
+# 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
+  class Violation
+    class IllegalAttributeValue < self
+      def initialize(service_id, violation_hash)
+        super
+        @attribute = Attribute.new(violation_hash['attribute'])
+      end
+
+      def get_input_and_apply_fix
+        Fix::SetAttribute.get_input_and_apply_fix(@service_id, @attribute)
+      end
+    end
+
+    class RequiredUnsetAttribute < self
+      def initialize(service_id, violation_hash)
+        super
+        @attribute = Attribute.new(violation_hash['attribute'])
+      end
+
+      def get_input_and_apply_fix
+        Fix::SetAttribute.get_input_and_apply_fix(@service_id, @attribute)
+      end
+
+    end
+
+    class InvalidCredentials < self
+      def initialize(service_id, violation_hash)
+        super
+        @attributes = violation_hash['fix_hashes'].map { |hash|  Attribute.new(hash['attribute']) } 
+      end
+
+      def get_input_and_apply_fix
+        result = nil
+        @attributes.each do |attribute| 
+          result = Fix::SetAttribute.get_input_and_apply_fix(@service_id, attribute)
+          return result if result.skip_all? or result.error?
+        end
+        result.ok? ? Fix::Result.rerun_violation_check : result
+      end
+    end
+  end
+end
+

data/puppet/manifests/init.pp

@@ -0,0 +1,72 @@
+class dtk_client($server_hostname)
+{
+  include dtk_client::params
+  $repos = $dtk_client::params::repos
+  $client_user = $dtk_client::params::client_user	
+  $client_user_homedir = $dtk_client::params::client_user_homedir
+  $dtk_username = $dtk_client::params::dtk_username
+  $dtk_password = $dtk_client::params::dtk_password
+  $client_src_path = $dtk_client::params::repo_targets['client']
+  $dtk_client_bin_path = "${client_user_homedir}/${client_src_path}/bin"
+  
+  package {['thor','activesupport']:
+    ensure   => 'installed',
+    provider => 'gem'
+  }
+
+  user { $client_user: 
+   home       => $client_homedir,
+   shell      => '/bin/bash',
+   managehome => true
+  }  
+  
+  file { "${client_user_homedir}/.bash_profile":
+    content => template('dtk_client/bash_profile.erb'),
+    owner   => $client_user,
+    require => User[$client_user]
+  }
+  
+  file { "${client_user_homedir}/dtk/connection.conf":
+    content => template('dtk_client/dtkclient.erb'),
+    owner   => $client_user,
+    require => User[$client_user]
+  }
+  
+  file { '/etc/dtk/':
+    ensure => directory,
+    owner   => $client_user,
+    require => User[$client_user]
+  }
+  
+  file { '/etc/dtk/client.conf':
+    content => template('dtk_client/client.conf.erb'),
+    owner   => $client_user,
+    require => File['/etc/dtk/']
+  }
+  dtk_client::github_repo { $repos:
+    require => User[$client_user]
+  }
+}
+
+#TODO: change to real app deployment; this only works when right keys already on node
+define dtk_client::github_repo(
+)
+{
+   $repo = $name
+   include dtk_client::params
+   $repo_url = $dtk_client::params::repo_urls[$repo]
+   $target = $dtk_client::params::repo_targets[$repo]
+   $client_user = $dtk_client::params::client_user
+   $client_user_homedir = $dtk_client::params::client_user_homedir
+     
+   $repo_target_dir = "${client_user_homedir}/${target}"
+   $git_clone_cmd = "git clone ${repo_url} ${repo_target_dir}"
+   $chown_cmd = "chown -R ${client_user} ${repo_target_dir}"
+   
+   exec { "clone ${name}":
+     command   => "${git_clone_cmd}; ${chown_cmd}",
+     path      => ['/bin','/usr/bin'],
+     logoutput => true,
+     creates   => $repo_target_dir
+   } 
+}