added xcsconfig commands - store bot configurations in git

Author: Honza Dvorsky

bin/xcskarel

@@ -33,6 +33,51 @@ class XCSKarelApplication
     global_option('--no_pretty', 'Disables output JSON prettification')
     global_option('--no_filter', 'Prints full JSON payload for objects instead of just filtering the important ones')
 
+    # Managing local xcsconfig folder
+
+    command :'config list' do |c|
+      c.syntax = 'xcskarel config [options]'
+      c.description = 'Lists the Xcode Bot configurations found in this folder'
+      c.action do |args, options|
+        config_folder = XCSKarel::XCSFile.get_config_folder
+        return unless config_folder
+        configs = XCSKarel::XCSFile.load_configs(config_folder)
+        if configs.count == 0
+          XCSKarel.log.info "Found no existing configs in #{config_folder}".yellow
+        else
+          out = "\n" + configs.map { |c| "#{File.basename(c.path)}".yellow + " - from " + "\"#{c.name}\"".yellow + ", created at #{c.created}" }.join("\n")
+          XCSKarel.log.info "Found #{configs.count} configs in \"#{config_folder}\":"
+          XCSKarel.log.info out
+        end
+      end
+    end
+
+    command :'config new' do |c|
+      c.syntax = 'xcskarel config new [options]'
+      c.description = 'Starts the interactive process of creating a new config from an existing Bot'
+      add_xcs_options(c)
+      c.action do |args, options|
+        
+        # let user chose a bot from the server
+        server = create_server_from_options(options)
+        bot = XCSKarel::Application.choose_bot(server)
+
+        # get our config folder
+        config_folder = XCSKarel::XCSFile.get_config_folder
+        return unless config_folder
+
+        # dump the bot into that config folder under a random name
+        new_config_path = XCSKarel::XCSFile.new_config_name(config_folder)
+        new_config = XCSKarel::Config.new(bot, server.api_version, new_config_path)
+        new_config.save
+
+        XCSKarel.log.info "Saved Bot \"#{new_config.name}\" configuration to #{new_config_path}.".green
+        system "open \"#{new_config_path}\""
+      end
+    end
+
+    # Talking to Xcode Server API
+
     command :bots do |c|
       c.syntax = 'xcskarel bots [options]'
       c.description = 'Fetches all Bots found on the specified server'
@@ -87,6 +132,8 @@ class XCSKarelApplication
       end
     end
 
+    # Managing a local Xcode Server
+
     command :'server start' do |c|
       c.syntax = 'xcskarel server start [options]'
       c.description = 'Start local Xcode Server'
@@ -137,6 +184,8 @@ class XCSKarelApplication
       end
     end
 
+    # Managing Xcode
+
     command :'xcode select' do |c|
       c.syntax = 'xcskarel xcode select'
       c.description = 'Interactive xcode-select'

lib/xcskarel.rb

@@ -4,4 +4,6 @@
 require 'xcskarel/log'
 require 'xcskarel/filter'
 require 'xcskarel/control'
-require 'xcskarel/bot'
+require 'xcskarel/config'
+require 'xcskarel/xcsfile'
+require 'xcskarel/application'

lib/xcskarel/application.rb

@@ -0,0 +1,13 @@
+module XCSKarel
+  module Application
+    def self.choose_bot(server)
+      all_bots = server.get_bots
+      bot_names = all_bots.map { |json| "#{json['name']} (#{json['_id']})" }
+      puts "Which Bot should be used as a template?"
+      choice = choose(*bot_names)
+      bot = all_bots[bot_names.index(choice)]
+      XCSKarel.log.info "Chose Bot \"#{bot['name']}\""
+      return bot
+    end
+  end
+end

lib/xcskarel/bot.rb

@@ -0,0 +1,86 @@
+module XCSKarel
+  class Config
+    attr_reader :json
+    attr_reader :path
+    attr_reader :api_version
+
+    def initialize(json, api_version, path)
+      @json = json
+      @path = path
+      @api_version = api_version || (config_json ? config_json['api_version'] : nil)
+    end
+
+    def name
+      @json['name'] || config_json['original_bot_name']
+    end
+
+    def created
+      config_json['time_generated']
+    end
+
+    def config_json
+      @json['xcsconfig']
+    end
+
+    def key_paths_for_persistance
+      key_paths_for_xcode_server << "xcsconfig"
+    end
+
+    def key_paths_for_xcode_server
+      ["configuration"]
+    end
+
+    def format_version
+      1
+    end
+
+    def json_for_persistence
+      filtered = XCSKarel::Filter.filter_key_paths(@json, key_paths_for_persistance)
+
+      # also add xcsconfig metadata
+      unless filtered["xcsconfig"]
+        filtered["xcsconfig"] = {
+          format_version: format_version,
+          app_version: XCSKarel::VERSION,
+          time_generated: Time.new.to_s,
+          original_bot_name: @json['name'],
+          api_version: @api_version
+        }
+      end
+      return filtered
+    end
+
+    def json_for_xcode_server
+      XCSKarel::Filter.filter_key_paths(@json, key_paths_for_xcode_server)
+    end
+
+    def self.from_file(file_path)
+      abs_path = File.absolute_path(file_path)
+      raise "No file #{abs_path}" unless File.exist?(abs_path)
+      config = self.new(JSON.parse(File.read(abs_path)), nil, abs_path)
+      unless config.validate_loaded
+        XCSKarel.log.warn "Skipping invalid config #{abs_path}".yellow
+        return nil
+      end
+      return config
+    end
+
+    def validate_loaded
+      return false unless config_json
+      return true
+    end
+
+    def to_file(file_path)
+      abs_path = File.absolute_path(file_path)
+      raise "File #{abs_path} already exists." if File.exist?(abs_path)
+      FileUtils.mkdir_p(File.dirname(abs_path))
+      File.open(abs_path, 'w') do |f|  
+        f.puts JSON.pretty_generate(json_for_persistence) + "\n"
+      end
+    end
+
+    def save
+      to_file(@path)
+    end
+  end
+end

lib/xcskarel/config.rb

@@ -24,7 +24,9 @@ def self.filter_key_paths(object, key_paths)
             key.split('.').first == keys.first
           end.first
           if match
-            new_hash[keys.first] = filter_key_paths(v, match.split('.').drop(1))
+            child_key_paths = match.split('.').drop(1)
+            # if there are no more key paths, we just take everything (whitelisted by default)
+            new_hash[keys.first] = child_key_paths.count == 0 ? v : filter_key_paths(v, child_key_paths)
           end
         end
         return new_hash

lib/xcskarel/filter.rb

@@ -11,6 +11,7 @@ class Server
     attr_reader :user
     attr_reader :pass
     attr_reader :port
+    attr_reader :api_version
 
     def initialize(host, user=nil, pass=nil, allow_self_signed=true)
       @port = 20343
@@ -88,7 +89,8 @@ def validate_connection(allow_self_signed)
         raise "Failed to validate - #{e}.\nPlease make sure your Xcode Server is up and running at #{host}. Run `xcskarel server start` to start a new local Xcode Server instance.".red
       else
         raise "Failed to validate - Endpoint at \"#{url}\" responded with #{response.data[:status_line]}".red if response.status != 204
-        XCSKarel.log.debug "Validation of host #{@host} succeeded.".green
+        @api_version = response.headers['X-XCSAPIVersion'].to_s
+        XCSKarel.log.debug "Validation of host #{@host} (API version #{@api_version}) succeeded.".green
       end
     end
   end

lib/xcskarel/server.rb

@@ -0,0 +1,70 @@
+module XCSKarel
+  module XCSFile
+    def self.folder_name
+      "xcsconfig"
+    end
+
+    def self.file_name
+      "xcsfile.json"
+    end
+
+    def self.find_config_folder_in_current_folder
+      self.find_config_folder_in_folder(Dir.pwd)
+    end
+
+    def self.find_config_folder_in_folder(folder)
+      # look for the xcsconfig folder with an xcsfile inside
+      abs_folder = File.absolute_path(folder)
+      found_folder = Dir[File.join(abs_folder, "/", "*")].select do |f|
+        File.basename(f) == self.folder_name
+      end.first
+      return found_folder
+    end
+
+    def self.create_config_folder_in_current_folder
+      self.create_config_folder_in_folder(Dir.pwd)
+    end
+
+    def self.create_config_folder_in_folder(folder)
+      abs_folder = File.absolute_path(folder)
+      config_folder = File.join(abs_folder, self.folder_name)
+      FileUtils.mkdir_p(config_folder)
+      return config_folder
+    end
+
+    def self.get_config_folder
+      config_folder = XCSKarel::XCSFile.find_config_folder_in_current_folder
+      unless config_folder
+        should_create = agree("There is no xcsconfig folder found, should I create one for you? (y/n)".red)
+        if should_create
+          config_folder = XCSKarel::XCSFile.create_config_folder_in_current_folder unless config_folder
+          XCSKarel.log.debug "Folder #{config_folder} created".yellow
+        else
+          return nil
+        end
+      end
+      # we have a config folder
+      XCSKarel.log.debug "Config folder found: #{config_folder}".green
+      return config_folder
+    end
+
+    def self.load_configs(folder)
+      require 'json'
+      Dir[File.join(folder, "/", "botconfig_*.json")].map do |f|
+        XCSKarel::Config.from_file(f)
+      end.select do |c|
+        c != nil
+      end
+    end
+
+    def self.random_name
+      require 'securerandom'
+      "botconfig_#{SecureRandom.hex(6)}.json"
+    end
+
+    def self.new_config_name(folder)
+      File.join(folder, self.random_name)
+    end
+
+  end
+end

lib/xcskarel/xcsfile.rb

@@ -43,6 +43,25 @@ def test(inObj, key_paths)
       expect(test(obj, ["oranges.old"])).to eq(exp)
     end
 
+    it "keeps full values when hashes and key is already whitelisted" do
+      obj = {
+        "apples" => "green",
+        "blackberries" => 12,
+        "oranges" => {
+          "new" => 2,
+          "old" => -2
+        }
+      }
+      exp = {
+        "apples" => "green",
+        "oranges" => {
+          "new" => 2,
+          "old" => -2
+        }
+      }
+      expect(test(obj, ["oranges", "apples"])).to eq(exp)
+    end
+
     it "handles basic key path with an array without popping the key path" do
       obj = [
         "apples",