gclouder_undefined_resources 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56c98b99f115e32b4cfcae1b07742311f64be18d
-  data.tar.gz: 63e9d56682db03437461db4339da7988018a148a
+  metadata.gz: 20430b49eb8ba80923b7f889e8ea10e4231a69fd
+  data.tar.gz: 526c81e66012a0d5638deb36cd7f3e062ca52759
 SHA512:
-  metadata.gz: cb17a0352d4631617f9994bd744520c83a728da139070cd15ca31d2c85e88c4aebfc23aaf7591854f5bb70f39561ae0b59bbda6e05a115ab9c3097fb2a2027a9
-  data.tar.gz: 1dd7b59229eb2ed4a929a86aa35eca7db6fcfb85a46dc101a12bad0339059a416ed0e23ff9fa67858d621db61f710f69f051a7bbdb5334be7d73370b7a9ffc2d
+  metadata.gz: b5c005bda0d49fd5ae55b65aab68262a45da0eaa89d170b7634ae59bfb141a8381c70b53dbb7c5fc0ae990075f70406f7d8f5cbb0534451cea1bacfab1d53644
+  data.tar.gz: d9ee105a14940609a5850ebfe1f918aeb428b8c43a04f1899ab9f32048c4f8f7d5f86479b4245d16d70873d12b37da827234b4af284ff00727221cada9aea1bb

data/lib/gclouder_undefined_resources.rb

@@ -13,6 +13,7 @@ require "gclouder_undefined_resources/local_resources"
 require "gclouder_undefined_resources/remote_resources"
 require "gclouder_undefined_resources/remote_resources/remote"
 require "gclouder_undefined_resources/remote_resources/resource"
+require "gclouder_undefined_resources/remote_resources/resource/symbols"
 
 module GClouderUndefinedResources
   def self.run
@@ -50,5 +51,9 @@ module GClouderUndefinedResources
     else
       puts "unknown group-by type"
     end
+
+    remote_resources.display_report unless CLIArgs.cli_args[:hide_report]
+
+    exit 1 if remote_resources.any_undefined_and_unfiltered?
   end
 end

data/lib/gclouder_undefined_resources/cli_args.rb

@@ -18,13 +18,20 @@ module GClouderUndefinedResources
       option_parser = Trollop::Parser.new do
         banner "\n  undefined gcp resources\n "
 
-        opt :local_resources,  "file containing local resource definitions", type: :string, required: true
-        #opt :remote_resources, "file containing remote resource definitions\n ", type: :string, required: true
-        opt :group_by,         "how to format output. valid values include: location, type", type: :string, default: "location"
-        opt :filter_config,    "file containing filter config", type: :string
-        opt :show_filtered,    "show filter matching output\n ", type: :bool
-        opt :key_file,         "specify key file for gcloud(1) authentication\n ", type: :string
-        opt :verbose,          "verbose\n ", type: :bool
+        opt :local_resources,    "file containing local resource definitions", type: :string, required: true
+        opt :filter_config,      "file containing filter config", type: :string
+        opt :key_file,           "specify key file for gcloud(1) authentication\n ", type: :string
+
+        opt :group_by,           "how to format output. valid values include: location, type\n ", type: :string, default: "location"
+
+        opt :show_filter_rule,   "show filter matching output", type: :bool
+        opt :show_filter_name,   "include filter rule name in output\n ", type: :bool
+
+        opt :hide_filtered,      "hide filtered results from output", type: :bool, default: false
+        opt :hide_defined,       "hide defined results from output", type: :bool, default: false
+        opt :hide_report,        "display statistics for each resource status type\n ", type: :bool
+
+        opt :verbose,            "verbose\n ", type: :bool
       end
 
       @cli_args = Trollop.with_standard_exception_handling(option_parser) do

data/lib/gclouder_undefined_resources/remote_resources.rb

@@ -2,24 +2,6 @@
 
 module GClouderUndefinedResources
   class RemoteResources
-    module Symbols
-      def self.tick
-        "✓".green
-      end
-
-      def self.x
-        "✗".red
-      end
-
-      def self.tick_filtered
-        "✓".yellow
-      end
-
-      def self.x_filtered
-        "✗".yellow
-      end
-    end
-
     def initialize(project_id)
       @project_id = project_id
       @resources = []
@@ -27,6 +9,14 @@ module GClouderUndefinedResources
 
     def collect
       add Remote::GCloud.fetch(@project_id)
+
+      @resources = @resources.reject do |resource|
+        CLIArgs.cli_args[:hide_filtered] && resource.filtered?
+      end
+
+      @resources = @resources.reject do |resource|
+        CLIArgs.cli_args[:hide_defined] && resource.defined?
+      end
     end
 
     def add(resources)
@@ -66,15 +56,7 @@ module GClouderUndefinedResources
             puts
 
             resources_by_region.each do |resource|
-              if resource.filtered?
-                status = resource.defined? ? Symbols.tick_filtered : Symbols.x_filtered
-              else
-                status = resource.defined? ? Symbols.tick : Symbols.x
-              end
-
-              # FIXME: do the skipping stuff here, or display status of the resource name..
-              # FIXME: to_s in resource could include x or tick or whatever
-              puts "        #{status} #{resource.name}"
+              puts "        #{resource}"
             end
           end
         end
@@ -108,19 +90,33 @@ module GClouderUndefinedResources
             puts
 
             resources_by_type.each do |resource|
-              if resource.filtered?
-                status = resource.defined? ? Symbols.tick_filtered : Symbols.x_filtered
-              else
-                status = resource.defined? ? Symbols.tick : Symbols.x
-              end
-
-              # FIXME: do the skipping stuff here, or display status of the resource name..
-              # FIXME: to_s in resource could include x or tick or whatever
-              puts "        #{status} #{resource.name}"
+              puts "        #{resource}"
             end
           end
         end
       end
     end
+
+    def display_report
+      status_types = @resources.group_by { |resource| resource.status }
+
+      return if status_types.empty?
+
+      puts
+      puts "  report"
+      puts
+      status_types.each do |status_type, resources|
+        puts "    #{status_type} - #{resources.length}"
+      end
+      puts
+    end
+
+    def any_undefined_and_unfiltered?
+      status_types = @resources.group_by { |resource| resource.status }
+
+      return if status_types.empty?
+
+      status_types.key?("✗".red)
+    end
   end
 end

data/lib/gclouder_undefined_resources/remote_resources/remote.rb

@@ -26,6 +26,7 @@ module GClouderUndefinedResources
           end
         end
 
+        # FIXME: refactor
         module ResourcesList
           def self.fetch(project_id)
             json = JSON.parse(Shell.run("gcloud alpha resources list --format json"))
@@ -33,15 +34,31 @@ module GClouderUndefinedResources
             json.select do |resource|
               result = true
 
-              result = nil unless resource["selfLink"] =~ /projects\/#{project_id}\//
+              if resource.key?("projectId")
+                result = nil if resource["projectId"] != project_id
+                #puts "skipping resource because project id does not match: #{resource['projectId']}"
+              elsif resource.key?("selfLink")
+                result = nil if resource["selfLink"] !~ /projects\/#{project_id}\//
+                #puts "skipping resource because project id does not match: #{resource['selfLink']}"
+              else
+                ap resource
+                puts "error: resource has no selfLink or projectId property, unable to determine project id"
+                exit 1
+              end
 
-              if resource["@type"] == "type.googleapis.com/google.cloud.dataproc.v1.Job"
-                puts "skipping data proc resource: #{resource['reference']}, #{resource['placement']}"
-                result = nil
+              if !resource.key?("name")
+                puts "resource has no name key:"
+                ap resource
               end
 
               result
             end.map do |resource|
+              if !resource.key?("name")
+                ap resource
+                puts "error: resource has no name key"
+                exit 1
+              end
+
               Resource.new(resource["name"], resource)
             end
           end

data/lib/gclouder_undefined_resources/remote_resources/resource.rb

@@ -22,6 +22,8 @@ module GClouderUndefinedResources
       def region
         return unless @data.key?("selfLink")
         match = @data["selfLink"].match(/.*\/regions\/([^\/]+)/)
+        match = @data["location"].downcase if @data.key?("location") && !match[1]
+        return unless @data.key?("location") && @data["location"] == "global"
         return match[1] if match
         zone[0..-3] if zone
       end
@@ -34,6 +36,7 @@ module GClouderUndefinedResources
 
       def global?
         return true if zone.nil? && region.nil?
+        return true if @data.key?("location") && @data["location"] == "global"
         return unless @data.key?("selfLink")
         !@data["selfLink"].match(/.*\/projects\/[^\/]+\/global/).nil?
       end
@@ -84,20 +87,7 @@ module GClouderUndefinedResources
             next
           end
 
-          if CLIArgs.cli_args[:show_filtered]
-            puts "filter: "
-            puts "  description: #{filter['description']}"
-            puts "  region: #{filter['region']}"
-            puts "  zone: #{filter['zone']}"
-            puts "  type: #{filter['type']}"
-            puts "  name: #{filter['name']}"
-            puts "match: "
-            puts "  region: #{region}"
-            puts "  zone: #{zone}"
-            puts "  type: #{original_type}"
-            puts "  name: #{name}"
-            puts
-          end
+          @filter_rule = filter
 
           return true
         end
@@ -105,6 +95,54 @@ module GClouderUndefinedResources
         false
       end
 
+      # FIXME: refactor
+      def status
+        if self.filtered?
+          if self.defined?
+            if filter.dig("mark", "filtered")
+              filter["mark"]["filtered"]["symbol"].send(filter["mark"]["filtered"]["colour"])
+            else
+              Symbols.tick_filtered
+            end
+          else
+            if filter.dig("mark", "unfiltered")
+              filter["mark"]["unfiltered"]["symbol"].send(filter["mark"]["unfiltered"]["colour"])
+            else
+              Symbols.x_filtered
+            end
+          end
+        else
+          if self.defined?
+            Symbols.tick
+          else
+            Symbols.x
+          end
+        end
+      end
+
+      def filter
+        @filter_rule
+      end
+
+      def filter_description
+        if filter.key?("description")
+          "# #{filter["description"]}".gray
+        else
+          "# filter has no description".gray
+        end
+      end
+
+      def to_s
+        s = "#{status} #{name}"
+        s += " #{filter_description}" if CLIArgs.cli_args[:show_filter_name] and filtered?
+        s += "\n#{formatted_filter_rule}" if CLIArgs.cli_args[:show_filter_rule] and filtered?
+        s
+      end
+
+      def formatted_filter_rule
+        filter.ai.gsub("\n", "\n          ").gsub(/^{/, "          {")
+      end
+
       private
 
       def filters
@@ -120,13 +158,16 @@ module GClouderUndefinedResources
         when "serviceAccount"
           ["service_accounts"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/cloud.bigstore.api.Bucket"
-          []
+          ["buckets"]
 
         when "type.googleapis.com/cloud.dns.api.ManagedZone"
           ["dns", "zones"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/cloud.resourcemanager.Organization"
+          ["resource_manager", "organization"]
 
         when "type.googleapis.com/compute.BackendBucket"
           ["compute", "backend-buckets"]
@@ -161,8 +202,9 @@ module GClouderUndefinedResources
         when "type.googleapis.com/compute.Router"
           ["compute", "router"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/compute.SslCertificate"
-          []
+          ["compute", "ssl_certificate"]
 
         when "type.googleapis.com/compute.Subnetwork"
           ["subnets"]
@@ -176,26 +218,37 @@ module GClouderUndefinedResources
         when "type.googleapis.com/compute.UrlMap"
           ["compute", "url_maps"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/google.api.servicemanagement.v1.ManagedService"
-          []
+          ["service_management", "service"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/google.appengine.v1.Application"
-          []
+          ["app", "app"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/google.appengine.v1.Service"
-          []
+          ["app", "service"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/google.appengine.v1.Version"
-          []
+          ["app", "version"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/google.cloud.billing.v1.BillingAccount"
-          []
+          ["billing", "account"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/google.cloud.dataproc.v1.Cluster"
-          []
+          ["dataproc", "cluster"]
 
+        # TODO: not yet implemented in gclouder
         when "type.googleapis.com/google.cloudresourcemanager.projects.v1beta1.Project"
-          []
+          ["project"]
+
+        # TODO: not yet implemented in gclouder
+        when "type.googleapis.com/google.cloud.dataproc.v1.Job"
+          ["dataproc", "job"]
 
         else
           puts "error: unknown or no '@type' property found for data:"

data/lib/gclouder_undefined_resources/remote_resources/resource/symbols.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+module GClouderUndefinedResources
+  class RemoteResources
+    class Resource
+      module Symbols
+        def self.tick
+          "✓".green
+        end
+
+        def self.x
+          "✗".red
+        end
+
+        def self.tick_filtered
+          "✓".yellow
+        end
+
+        def self.x_filtered
+          "✗".yellow
+        end
+      end
+    end
+  end
+end

data/lib/gclouder_undefined_resources/version.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 module GClouderUndefinedResources
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gclouder_undefined_resources
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Rob Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -68,6 +68,7 @@ files:
 - lib/gclouder_undefined_resources/remote_resources.rb
 - lib/gclouder_undefined_resources/remote_resources/remote.rb
 - lib/gclouder_undefined_resources/remote_resources/resource.rb
+- lib/gclouder_undefined_resources/remote_resources/resource/symbols.rb
 - lib/gclouder_undefined_resources/resource.rb
 - lib/gclouder_undefined_resources/self_link.rb
 - lib/gclouder_undefined_resources/shell.rb