sqs-list-queues 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cc3bebdbdeef157d7ca36c992ee9cf342bef893
+  data.tar.gz: 90072d014b7cc86f65d8b323c1c98af5ecdc5204
+SHA512:
+  metadata.gz: cd425cb7fc9d7b22d5ea1644d67f33d5ece7a9ecc2f3c0fec7fb88c96b3811f7754ab32160a6f3d7c8fd4048eee535e84ba4ae00612507fc017d3a517a28be6d
+  data.tar.gz: 718cd925493432caee9cb1addafc9112f3190685cbf5ecfd9613305165f32e357197e22f099962530182dc2893f65c6cb95ac861742140af9705ded5912f5a55

data/bin/sqs-list-queues

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require 'sqs-list-queues'
+
+config = SqsListQueues::Config.new
+
+opts_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: sqs-list-queues [OPTIONS] [PATTERN ...]"
+  opts.separator ""
+  opts.on("-c", "--counts", "Show message counts") do
+    config.show_counts = true
+  end
+  opts.on("-a", "--arn", "Show queue ARN") do
+    config.show_arn = true
+  end
+  opts.on("-u", "--url", "Show queue URL") do
+    config.show_url = true
+  end
+  opts.on("-j", "--json", "Show output in json format") do
+    config.json_format = true
+  end
+  opts.separator ""
+  opts.separator <<-EOF
+
+Lists SQS queues (either all queues, or if at least one PATTERN is given,
+those queues whose names match at least one PATTERN, implicitly prefixed by
+"^").  One line is printed to standard output for each queue.
+
+If --counts is shown, prefix by the message counts (visible, not visible, and
+delayed, in that order); then show the queue name, or ARN, or URL.  If JSON
+format is selected, the queue name is always shown, and the ARN and URL can
+both be selected if desired.
+
+Examples:
+
+  # List all queue names
+  sqs-list-queues
+
+  # List queues whose names start with either "Foo" or "Bar", showing queue
+  # URLs not names:
+  sqs-list-queues --url Foo Bar
+
+  # List queues whose names start with "MyQueues", showing message counts:
+  sqs-list-queues --counts MyQueues
+
+  EOF
+end
+
+opts_parser.parse!
+
+unless ARGV.empty?
+  config.patterns = ARGV
+end
+
+config.validate
+
+rc = SqsListQueues::Runner.new(config).run
+exit rc
+
+# eof sqs-list-queues

data/lib/sqs-list-queues.rb

@@ -0,0 +1,5 @@
+require_relative './sqs-list-queues/client.rb'
+require_relative './sqs-list-queues/config.rb'
+require_relative './sqs-list-queues/lister.rb'
+require_relative './sqs-list-queues/runner.rb'
+require_relative './sqs-list-queues/version.rb'

data/lib/sqs-list-queues/client.rb

@@ -0,0 +1,25 @@
+module SqsListQueues
+
+  class Client
+
+    def self.configure
+      Aws.config.merge! core_v2_options
+    end
+
+    def self.core_v2_options
+      {
+	http_proxy: get_proxy,
+	user_agent_suffix: "sqs-list-queues #{VERSION}",
+	# http_wire_trace: true,
+      }
+    end
+
+    def self.get_proxy
+      e = ENV['https_proxy']
+      e = "https://#{e}" if e && !e.empty? && !e.start_with?('http')
+      return e
+    end
+
+  end
+  
+end

data/lib/sqs-list-queues/config.rb

@@ -0,0 +1,30 @@
+module SqsListQueues
+
+  class Config
+    # Stronger builder pattern would be nice
+    attr_accessor :client_options, :sqs_client,
+      :patterns,
+      :show_counts,
+      :show_arn,
+      :show_url,
+      :json_format
+
+    def initialize
+      @client_options = {}
+      @patterns = nil
+      @show_counts = false
+      @show_arn = false
+      @show_url = false
+      @json_format = false
+    end
+
+    def validate
+      unless @json_format
+        if @show_arn and @show_url
+          raise "Can't show both ARN and URL unless JSON format is selected"
+        end
+      end
+    end
+  end
+
+end

data/lib/sqs-list-queues/lister.rb

@@ -0,0 +1,66 @@
+module SqsListQueues
+
+  class Lister
+
+    # ListQueues /seems/ to return the queues in ASCII order (case sensitive).
+    # The following algorithm depends on this assumption.
+
+    # Allowed characters in SQS queue names, in that order (see above).
+    ALPHABET = ("0".."9").to_a \
+             + ["-"] \
+             + ("A".."Z").to_a \
+             + ["_"] \
+             + ("a".."z").to_a
+
+    # Ceiling of ListQueues results
+    MAX_RESULTS = 1000
+
+    def initialize(sqs_client)
+      @sqs_client = sqs_client
+    end
+
+    def get_possibly_truncated_list(prefix)
+      # $stderr.puts "Querying with prefix = #{prefix.inspect}"
+      @sqs_client.list_queues(queue_name_prefix: prefix).queue_urls
+    end
+
+    def get_full_list(prefix = "")
+      urls = get_possibly_truncated_list prefix
+
+      if urls.count < MAX_RESULTS
+        return urls
+      end
+
+      last_result = urls.last
+      last_name = File.basename last_result
+
+      # If prefix = "foo"
+      # and the last result we have is "foolish"
+      # then to discover things later than this, we have to use a longer prefix
+      # then "foo":
+      # - "foom", "foon" (etc, for all possible character after "l"), each of
+      # which must be iterated independently
+      # - but for "fool"... we can try "fool" (which will certainly return some
+      # results we already have), and _may_ return additional results
+
+      problematic_letter = last_name[prefix.length]
+
+      # The fool case
+      fool_names = get_full_list(prefix + problematic_letter)
+      index_of_last_result = fool_names.index last_result
+      fool_names = fool_names[index_of_last_result+1 .. -1]
+
+      # The foom, foon... case
+      problematic_index = ALPHABET.index problematic_letter
+      remaining_letters = ALPHABET[problematic_index+1 .. -1]
+
+      remaining_names = remaining_letters.map do |letter|
+        get_full_list(prefix + letter)
+      end
+
+      (urls + fool_names + remaining_names).flatten
+    end
+
+  end
+
+end

data/lib/sqs-list-queues/runner.rb

@@ -0,0 +1,128 @@
+require 'aws-sdk'
+require 'json'
+require 'rosarium'
+
+module SqsListQueues
+
+  class Runner
+
+    def initialize(config)
+      @config = config
+
+      @config.sqs_client ||= begin
+                               effective_options = SqsListQueues::Client.core_v2_options.merge(config.client_options)
+                               Aws::SQS::Client.new(effective_options)
+                             end
+    end
+
+    def promise
+      promise_queue_urls.then do |queue_urls|
+        Rosarium::Promise.all(queue_urls.map {|queue_url| promise_queue queue_url}.reject &:nil?)
+      end
+    end
+
+    def promise_queue_urls
+      prefixes = get_pattern_prefixes
+
+      if prefixes.empty? or prefixes.any? {|prefix| prefix == ""}
+        Rosarium::Promise.execute do
+          SqsListQueues::Lister.new(@config.sqs_client).get_full_list
+        end
+      else
+        Rosarium::Promise.all(
+          prefixes.map do |prefix|
+            Rosarium::Promise.execute do
+              SqsListQueues::Lister.new(@config.sqs_client).get_full_list(prefix)
+            end
+          end
+        ).then do |v|
+          v.flatten.uniq
+        end
+      end
+    end
+
+    def get_pattern_prefixes
+      if @config.patterns.nil?
+        []
+      else
+        @config.patterns.map do |pattern|
+          pattern.match(/^([0-9A-Za-z_-]*)/)[1]
+        end
+      end
+    end
+
+    def pattern_to_string_prefix(pattern)
+      m = pattern.match /^/
+    end
+
+    def promise_queue(queue_url)
+      queue_name = File.basename queue_url
+      return nil unless name_matches_patterns?(queue_name)
+
+      Rosarium::Promise.execute do
+        r = {
+          name: queue_name,
+          url: queue_url,
+        }
+
+        required_attributes = []
+
+        if @config.show_arn
+          required_attributes << 'QueueArn'
+        end
+
+        if @config.show_counts
+          required_attributes << 'ApproximateNumberOfMessages'
+          required_attributes << 'ApproximateNumberOfMessagesNotVisible'
+          required_attributes << 'ApproximateNumberOfMessagesDelayed'
+        end
+
+        unless required_attributes.empty?
+          r[:attributes] = @config.sqs_client.get_queue_attributes(
+            queue_url: queue_url,
+            attribute_names: required_attributes,
+          ).attributes
+        end
+
+        r
+      end
+    end
+
+    def name_matches_patterns?(queue_name)
+      return true if @config.patterns.nil?
+
+      @config.patterns.any? do |pattern|
+        queue_name.match("^" + pattern)
+      end
+    end
+
+    def run
+      promise.then do |queues|
+        queues.each do |queue|
+          if @config.json_format
+            puts JSON.generate(queue)
+          else
+            if @config.show_counts
+              msg = queue[:attributes]["ApproximateNumberOfMessages"]
+              invis = queue[:attributes]["ApproximateNumberOfMessagesNotVisible"]
+              delayed = queue[:attributes]["ApproximateNumberOfMessagesDelayed"]
+              print "#{msg}\t#{invis}\t#{delayed}\t"
+            end
+
+            if @config.show_arn
+              puts queue[:attributes]["QueueArn"]
+            elsif @config.show_url
+              puts queue[:url]
+            else
+              puts queue[:name]
+            end
+          end
+        end
+      end.value!
+
+      return 0
+    end
+
+  end
+
+end

data/lib/sqs-list-queues/version.rb

@@ -0,0 +1,3 @@
+module SqsListQueues
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sqs-list-queues
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rachel Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rosarium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: "\n    sqs-list-queues lists your SQS queues (working around the 1000
+  queue limit\n    in the ListQueues API).\n\n    Options are available to filter
+  by queue name, show message counts, show\n    queue ARNs and/or names, and output
+  as json.\n\n    Respects $https_proxy.\n  "
+email: sqs-list-queues-git@rve.org.uk
+executables:
+- sqs-list-queues
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/sqs-list-queues
+- lib/sqs-list-queues.rb
+- lib/sqs-list-queues/client.rb
+- lib/sqs-list-queues/config.rb
+- lib/sqs-list-queues/lister.rb
+- lib/sqs-list-queues/runner.rb
+- lib/sqs-list-queues/version.rb
+homepage: https://github.com/rvedotrc/sqs-list-queues
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: List SQS queues, optionally with message counts and more
+test_files: []