xcskarel 0.11.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf58b04b0c57a70a57293e17fe3bb66bde17a5f8
-  data.tar.gz: afb87c39726475e9e85b1c04d74bef54adb7a104
+  metadata.gz: f69158b3f6c2220edec0c74f13e59c1dc1785ae5
+  data.tar.gz: 2584d85e540450a8c65e52ea9f2987a23b93e8e3
 SHA512:
-  metadata.gz: 8f8aaa7c01000090168ef4f12445395135508928271ae0db44bd9a8f57a7e9c13b7fcf6a3b633e4189948044ae25a60b559ebaef8785a3e0779d90d2a6709b39
-  data.tar.gz: 9e0b9728393772d7ecef24d97162e31c10f023819fa3176fc7c9c16b7eb2b93b79ad12dee1e43630e0febbbbd5bbcfbd7477e38798e6b08c1413585f71beb7ed
+  metadata.gz: 2ecc1b825c615c8be675b732a52639553bcdbd34d10200499d70de79dd78bdf7ef82c70d794f5f7b2125cdd7a07d96e09b838de32a6e8e8551aa5cdf73e39833
+  data.tar.gz: 7136da6e5c5d838eb575d54aad6ffbcd060dce1265b0a87b76d9f4adba2e8b41354f306c7c544497c37237892381a1c6852770fb52bc3b1e98b3f8746d2e6b77

data/bin/xcskarel

@@ -12,18 +12,25 @@ class XCSKarelApplication
   include Commander::Methods
 
   def add_xcs_options(c)
-    c.option '--host Hostname', '(required) Xcode Server\'s hostname or IP address (default: localhost)'
-    c.option '--user Username', 'Xcode Server username'
-    c.option '--pass Password', 'Xcode Server password'
+    c.option '--host Hostname', 'Xcode Server\'s hostname or IP address (default: localhost) (also can be specified as the environment variable XCSKAREL_HOST)'
+    c.option '--user Username', 'Xcode Server username (also can be specified as the environment variable XCSKAREL_USER)'
+    c.option '--pass Password', 'Xcode Server password (also can be specified as the environment variable XCSKAREL_PASS)'
   end
 
   def add_bot_options(c)
-    c.option '--bot BOT_ID', '(required) Bot identifier'
+    c.option '--bot BOT_ID_OR_NAME', '(required) Bot identifier or name'
+  end
+
+  def add_bot_or_integration_options(c)
+    c.option '--bot BOT_ID_OR_NAME', 'Bot identifier or name'
+    c.option '--integration INTEGRATION_ID', 'Integration identifier'
   end
 
   def create_server_from_options(options)
-    host = options.host || "localhost"
-    XCSKarel::Server.new(host, options.user, options.pass)
+    host = options.host || ENV['XCSKAREL_HOST'] || "localhost"
+    user = options.user || ENV['XCSKAREL_USER']
+    pass = options.pass || ENV['XCSKAREL_PASS']
+    XCSKarel::Server.new(host, user, pass)
   end
 
   def run
@@ -92,14 +99,7 @@ class XCSKarelApplication
       c.action do |args, options|
         server = create_server_from_options(options)
         all_bots = server.get_bots
-        # create Bot instances
-        # bot_objs = all_bots.map { |json| XCSKarel::Bot.new(json) }
-        # bot_files = bot_objs.map { |bot| name = "./xcskarel/#{bot.json['_id']}.json"; bot.to_file(name); name }
-        unless options.no_filter
-          all_bots = XCSKarel::Filter.filter_key_paths(all_bots, ['name', '_id'])
-        end
-        out = options.no_pretty ? JSON.generate(all_bots) : JSON.pretty_generate(all_bots)
-        puts out
+        puts XCSKarel::Application.format(all_bots, options, ['name', '_id'])
       end
     end
 
@@ -112,12 +112,37 @@ class XCSKarelApplication
       c.action do |args, options|
         raise "No Bot id was specified, please see `xcskarel integrations --help`" unless options.bot
         server = create_server_from_options(options)
-        all_integrations = server.get_integrations(options.bot)
-        unless options.no_filter
-          all_integrations = XCSKarel::Filter.filter_key_paths(all_integrations, ['number', '_id', 'currentStep', 'result'])
-        end
-        out = options.no_pretty ? JSON.generate(all_integrations) : JSON.pretty_generate(all_integrations)
-        puts out
+        all_integrations = XCSKarel::Application.integrations(server, options.bot)
+        puts XCSKarel::Application.format(all_integrations, options, ['number', '_id', 'currentStep', 'result'])
+      end
+    end
+
+    command :issues do |c|
+      c.syntax = 'xcskarel issues [options]'
+      c.description = 'Fetches issues of an integration or a Bot\'s last integration'
+      c.example 'fetches issues for a given integration on localhost', 'xcskarel issues --integration 448946985304230369392c2e6b05a821'
+      c.example 'fetches issues for a given bot\'s last integration', 'xcskarel issues --bot "My Bot" --host 192.168.1.64'
+      add_xcs_options(c)
+      add_bot_or_integration_options(c)
+      c.action do |args, options|
+        server = create_server_from_options(options)
+        bot = options.bot
+        integration = options.integration
+        raise "Exactly one of Bot or Integration must be specified, please see `xcskarel issues --help`" unless bot || integration
+        all_issues = XCSKarel::Application.issues(server, bot, integration)
+        key_paths = [
+          'buildServiceErrors.*', 
+          'buildServiceWarnings.message', 
+          'triggerErrors.*',
+          'analyzerWarnings.*', 
+          'errors.*.message',
+          'testFailures.*.testCase', 
+          'testFailures.*.documentFilePath', 
+          'testFailures.*.message',
+          'warnings.*.message',
+          'warnings.*.documentFilePath'
+        ]
+        puts XCSKarel::Application.format(all_issues, options, key_paths, false)
       end
     end
 
@@ -144,11 +169,7 @@ class XCSKarelApplication
       c.action do |args, options|
         server = create_server_from_options(options)
         all_health = server.get_health
-        unless options.no_filter
-          all_health = XCSKarel::Filter.filter_key_paths(all_health, ['uptime'])
-        end
-        out = options.no_pretty ? JSON.generate(all_health) : JSON.pretty_generate(all_health)
-        puts out
+        puts XCSKarel::Application.format(all_health, options, ['uptime'])
       end
     end
 

data/lib/xcskarel/application.rb

@@ -1,3 +1,6 @@
+require 'xcskarel/filter'
+require 'json'
+
 module XCSKarel
   module Application
     def self.choose_bot(server)
@@ -91,6 +94,12 @@ module XCSKarel
       puts table.to_s
     end
 
+    def self.integrations(server, bot_id_or_name)
+      bot = server.find_bot_by_id_or_name(bot_id_or_name)
+      XCSKarel.log.debug "Found Bot #{bot['name']} with id #{bot['_id']}".yellow
+      server.get_integrations(bot['_id'])
+    end
+
     def self.integrate(server, bot_id_or_name)
 
       # find bot by id or name
@@ -104,5 +113,50 @@ module XCSKarel
       self.print_status(server)
     end
 
+    def self.issues(server, bot_id_or_name, integration_id)
+      integration = nil
+      if bot_id_or_name
+        bot = server.find_bot_by_id_or_name(bot_id_or_name)
+        # fetch last integration
+        integration = (server.get_integrations(bot['_id']).first || {})['_id']
+        raise "No Integration found for Bot \"#{bot['name']}\"".red unless integration
+      else
+        integration = server.get_integration(integration_id)['_id']
+        raise "No Integration found for id #{integration_id}".red unless integration
+      end
+
+      # fetch issues
+      issues = server.get_issues(integration)
+      return issues
+    end
+
+    def self.format(object, options, allowed_key_paths, allow_empty_container_leaves=true)
+      unless options.no_filter
+
+        extra_filters = []
+
+        unless allow_empty_container_leaves
+          # optionally add an override to filter out empty containers as leaves
+          empty_leaves = lambda do |k,v|
+            return true unless v.is_a?(Array) || v.is_a?(Hash)
+            return v.count > 0
+          end
+          extra_filters << empty_leaves
+        end
+
+        # create a super-filter composed from all the gathered filters
+        custom_filters = lambda do |k,v|
+          extra_filters.each do |filter|
+            return false unless filter.call(k,v)
+          end
+          return true
+        end
+
+        object = XCSKarel::Filter.filter_key_paths(object, allowed_key_paths, custom_filters)
+      end
+      out = options.no_pretty ? JSON.generate(object) : JSON.pretty_generate(object)
+      return out
+    end
+
   end
 end

data/lib/xcskarel/filter.rb

@@ -6,11 +6,11 @@ module XCSKarel
     # returns a copy of the passed-in hash with only the provided keypaths kept
     # e.g. "name" will keep the key "name" at the top level.
     # supports even nested keypaths
-    def self.filter_key_paths(object, key_paths)
+    def self.filter_key_paths(object, key_paths, custom_block=nil)
 
       # array?
       if object.is_a?(Array)
-        return self.filter_array(object, key_paths)
+        return self.filter_array(object, key_paths, custom_block)
       end
 
       # hash?
@@ -19,14 +19,31 @@ module XCSKarel
         unique_key_paths = Set.new(key_paths)
         object.each do |k,v|
 
+          next if !custom_block.nil? && !custom_block.call(k, v)
+
           keys = k.split('.') # key-paths must be separated by a period
-          match = unique_key_paths.select do |key|
-            key.split('.').first == keys.first
-          end.first
-          if match
-            child_key_paths = match.split('.').drop(1)
+          matches = unique_key_paths.select do |key|
+            kp = key.split('.')
+            kp.first == keys.first || kp.first == "*"
+          end
+          if matches.count > 0
+
+            child_key_paths = []
+            split_matches = matches.map { |match| match.split('.') }
+
+            # universal wildcard
+            if matches.index("*") != nil
+              child_key_paths = child_key_paths << "*" 
+            else
+              # normal key-path (including key-pathed wildcard)
+              child_key_paths = child_key_paths + split_matches.map { |split_match| split_match.drop(1).join('.') }
+            end
+
             # 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)
+            new_k = keys.first
+            new_v = filter_key_paths(v, child_key_paths, custom_block)
+            next if !custom_block.nil? && !custom_block.call(new_k, new_v)
+            new_hash[new_k] = new_v 
           end
         end
         return new_hash
@@ -39,11 +56,11 @@ module XCSKarel
     private
 
     # filters each element
-    def self.filter_array(array, key_paths)
+    def self.filter_array(array, key_paths, custom_block=nil)
       new_array = Array.new
       keys = Set.new(key_paths)
       array.each do |i|
-        new_array << filter_key_paths(i, key_paths)
+        new_array << filter_key_paths(i, key_paths, custom_block)
       end
       return new_array
     end

data/lib/xcskarel/server.rb

@@ -31,12 +31,29 @@ module XCSKarel
       bots.sort_by { |bot| bot['name'] }
     end
 
-    def get_integrations(bot_id)
-      response = get_endpoint("/bots/#{bot_id}/integrations")
+    def get_integrations(bot_id, limit=nil)
+      raise "No Bot id provided".red if !bot_id || bot_id.empty?
+      limit_s = limit ? "?last=#{limit}" : ""
+      response = get_endpoint("/bots/#{bot_id}/integrations#{limit_s}")
       raise "Failed to fetch Integrations for Bot #{bot_id} from Xcode Server at #{@host}, response: #{response.status}: #{response.body}".red if response.status != 200
       JSON.parse(response.body)['results']
     end
 
+    def get_integration(integration_id)
+      raise "No Integration id provided".red if !integration_id || integration_id.empty?
+      response = get_endpoint("/integrations/#{integration_id}")
+      raise "Failed to fetch an Integrations with id #{integration_id} from Xcode Server at #{@host}, response: #{response.status}: #{response.body}".red if response.status != 200
+      JSON.parse(response.body)
+    end
+
+    def get_issues(integration_id)
+      raise "No Integration id provided".red if !integration_id || integration_id.empty?
+      response = get_endpoint("/integrations/#{integration_id}/issues")
+      raise "Failed to fetch issues for an Integrations with id #{integration_id} from Xcode Server at #{@host}, response: #{response.status}: #{response.body}".red if response.status != 200
+      body = JSON.parse(response.body)
+      return body['results'] || body # support both xcode 6 and 7
+    end
+
     def get_health
       response = get_endpoint("/health")
       raise "Failed to get Health of #{@host}" if response.status != 200
@@ -52,7 +69,7 @@ module XCSKarel
         status['name'] = bot['name']
         status['id'] = bot['_id']
         status['branch'] = XCSKarel::Config.new(bot, nil, nil).branch
-        last_integration = self.get_integrations(bot['_id']).first # sorted from newest to oldest
+        last_integration = self.get_integrations(bot['_id'], 1).first # sorted from newest to oldest
         if last_integration
           status['current_step'] = last_integration['currentStep']
           status['result'] = last_integration['result']
@@ -78,10 +95,10 @@ module XCSKarel
       return integration
     end
 
-    def find_bot_by_id_or_name(id_or_name)
+    def find_bot_by_id_or_name(id_or_name, raise_if_none_found=true)
       bots = self.get_bots
       found_bots = bots.select { |bot| [bot['name'], bot['_id']].index(id_or_name) != nil }
-      raise "No Bot found for \"#{id_or_name}\"".red if found_bots.count == 0
+      raise "No Bot found for \"#{id_or_name}\"".red if raise_if_none_found && found_bots.count == 0
       XCSKarel.log.warn "More than one Bot found for \"#{id_or_name}\", taking the first one (you shouldn't have more Bots with the same name!)".red if found_bots.count > 1
       return found_bots.first
     end

data/lib/xcskarel/version.rb

@@ -1,3 +1,3 @@
 module XCSKarel
-  VERSION = '0.11.0'
+  VERSION = '0.14.0'
 end

data/spec/application_spec.rb

@@ -0,0 +1,39 @@
+require 'xcskarel/application'
+
+class Opts
+  attr_accessor :no_pretty
+  attr_accessor :no_filter
+end
+
+describe XCSKarel do
+  describe XCSKarel::Application do
+    describe "format" do
+
+      def default_options
+        opts = Opts.new
+        opts.no_filter = false
+        opts.no_pretty = false
+        return opts
+      end
+
+      it "filters correctly empty leaf arrays" do
+        object = [{
+          "errors" => {
+            "unresolvedIssues" => [],
+            "resolvedIssues" => []
+          },
+          "testFailures" => {
+            "unresolvedIssues" => ["one"],
+            "resolvedIssues" => []
+          }
+        }]
+        exp = JSON.pretty_generate([{
+            "testFailures" => {
+              "unresolvedIssues" => ["one"]
+            }
+        }])
+        expect(XCSKarel::Application.format(object, default_options, ["errors.*", "testFailures.*"], false)).to eq(exp)
+      end
+    end
+  end
+end

data/spec/filter_spec.rb

@@ -3,8 +3,8 @@ require 'xcskarel/filter'
 describe XCSKarel do
   describe XCSKarel::Filter do
 
-    def test(inObj, key_paths)
-      XCSKarel::Filter.filter_key_paths(inObj, key_paths)
+    def test(inObj, key_paths, custom_block=nil)
+      XCSKarel::Filter.filter_key_paths(inObj, key_paths, custom_block)
     end
 
     it "handles empty hash" do
@@ -59,7 +59,7 @@ describe XCSKarel do
           "old" => -2
         }
       }
-      expect(test(obj, ["oranges", "apples"])).to eq(exp)
+      expect(test(obj, ["oranges.*", "apples"])).to eq(exp)
     end
 
     it "handles basic key path with an array without popping the key path" do
@@ -78,5 +78,48 @@ describe XCSKarel do
       ]
       expect(test(obj, ["new"])).to eq(exp)
     end
+
+    it "custom block can override and filter out based on keys" do
+      obj = [
+        "apples",
+        {
+          "new" => ["one", "two"],
+          "old" => []
+        }
+      ]
+      exp = [
+        "apples",
+        {
+          "new" => ["one", "two"]
+        }
+      ]
+      custom_block = lambda do |k,v|
+        return true unless v.is_a?(Array)
+        return v.count > 0
+      end
+      expect(test(obj, ["new", "old"], custom_block)).to eq(exp)
+    end
+
+    it "handles the wildcard symbol in the middle of a keypath" do
+      obj = {
+        "errors" => {
+          "status" => 0,
+          "data" => "1234abcd"
+        },
+        "warnings" => {
+          "status" => 1,
+          "data" => "abcd1234"
+        }
+      }
+      exp = {
+        "errors" => {
+          "status" => 0
+        },
+        "warnings" => {
+          "status" => 1
+        }
+      }
+      expect(test(obj, ["*.status"])).to eq(exp)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcskarel
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Honza Dvorsky
@@ -196,6 +196,7 @@ files:
 - lib/xcskarel/server.rb
 - lib/xcskarel/version.rb
 - lib/xcskarel/xcsfile.rb
+- spec/application_spec.rb
 - spec/default_spec.rb
 - spec/filter_spec.rb
 homepage: http://github.com/czechboy0/xcskarel
@@ -223,6 +224,7 @@ signing_key:
 specification_version: 4
 summary: Manage your Xcode Server & Bots from the command line
 test_files:
+- spec/application_spec.rb
 - spec/default_spec.rb
 - spec/filter_spec.rb
 has_rdoc: