gcloud_hosts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ba67d06a8c97f3882fac1ff37cc025d3d64a7f1
+  data.tar.gz: 7520d469eec780d23438d6985d92e2cf87c75678
+SHA512:
+  metadata.gz: 5a2b239695545db654fe3ad1b01e11e84f2a17da16753f79c9dfea8fee940cfe9b2bf3b1e5c0daf40442df1c2a0817c9783cfb9524902121be993d5aaab24677
+  data.tar.gz: ca94497f4fc039bb66504cecbee41223ab61e11952b775f0949d1354dcedb6f1e5704ca1bf3e15a4fe9b20ff3451edf23678ee2a11ded8fae6ac587d07bda0e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gcloud_hosts.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# gcloud_hosts
+
+Update your hosts file based on gcloud compute instances.
+
+This is handy when used in conjunction with something like [sshuttle](https://github.com/sshuttle/sshuttle),
+allowing you to have a "poor man's vpn".
+
+## Installation
+
+```shell
+$ gem install gcloud_hosts
+```
+
+## Requirements
+
+Requires [gcloud tool](https://cloud.google.com/sdk/gcloud/) installed and authenticated against at least 1 GCP project.
+
+## Usage
+
+```shell
+$ gcloud_hosts -h
+Usage: $ gcloud_hosts [options]
+    -g, --gcloud GCLOUD              Path to gcloud executable. Defaults to PATH location
+    -p, --project PROJECT            gcloud project to use. Defaults to default gcloud configuration.
+    -n, --network NETWORK            gcloud network to filter on. Defaults nil.
+    -d, --domain DOMAIN              Domain to append to all hosts. Default: "c.[PROJECT].internal"
+        --public PUBLIC              Pattern to match for public/bastion hosts. Use public IP for these. Defaults to nil
+    -f, --file FILE                  Hosts file to update. Defaults to /etc/hosts
+    -b, --backup BACKUP              Path to backup original hosts file to. Defaults to FILE with '.bak' extension appended.
+        --[no-]dry-run               Dry run, do not modify hosts file. Defaults to false
+        --[no-]delete                Delete the project from hosts file. Defaults to false
+        --help                       Show this message
+        --version                    Show version
+```
+
+## Example
+
+Update your hosts file using gcloud_hosts:
+
+```shell
+$ sudo gcloud_hosts -p my-cool-project --public bastion
+
+```
+Start sshuttle session:
+
+```shell
+$ sshuttle --remote=bastion01 --daemon --pidfile=/tmp/sshuttle.pid 192.168.1.0/24
+```
+
+Now your hosts file will contain entries for all compute instances in the project,
+and you can ssh directly to them from your local machine.
+
+Hosts matching the pattern passed in with the `--public` flag will have their public
+IP address added to your host file instead of the their private internal IP address.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/atongen/gcloud_hosts](https://github.com/atongen/gcloud_hosts).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/gcloud_hosts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'gcloud_hosts'
+GcloudHosts::Runner.new(ARGV.dup).run!

data/gcloud_hosts.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gcloud_hosts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gcloud_hosts"
+  spec.version       = GcloudHosts::VERSION
+  spec.authors       = ["Andrew Tongen"]
+  spec.email         = ["atongen@gmail.com"]
+
+  spec.summary       = %q{Update your hosts file based on gcloud compute instances}
+  spec.description   = %q{Update your hosts file based on gcloud compute instances}
+  spec.homepage      = "https://github.com/atongen/gcloud_hosts"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gcloud_hosts/hosts.rb

@@ -0,0 +1,49 @@
+require 'json'
+
+module GcloudHosts
+  module Hosts
+
+    def self.instances(gcloud_path, project, network)
+      JSON.parse(%x{ #{gcloud_path} compute instances list --project #{project} --format json 2>/dev/null })
+        .select { |i| i["status"] == "RUNNING" }
+        .select do |i|
+          network.to_s.strip == "" ||
+          i["networkInterfaces"].any? { |ni| ni["network"] == network }
+        end.sort { |x,y| x["name"] <=> y["name"] }
+    end
+
+    def self.hosts(gcloud_path, project, network, domain, public_pattern)
+      instances(gcloud_path, project, network).inject([]) do |list, i|
+        begin
+          if public_pattern.to_s.strip != "" && i["name"].downcase.include?(public_pattern)
+            # get external ip address
+            i["networkInterfaces"].each do |ni|
+              ni["accessConfigs"].each do |ac|
+                if ac["name"].downcase.include?("nat") && ac["type"].downcase.include?("nat")
+                  if ip = ac["natIP"]
+                    str = "#{ip} #{i["name"]}"
+                    list << str
+                    raise HostError.new
+                  end
+                end
+              end
+            end
+          else
+            # get first internal private network interface
+            i["networkInterfaces"].each do |ni|
+              if ni["name"] == "nic0"
+                if ip = ni["networkIP"]
+                  str = "#{ip} #{i["name"]}"
+                  str << " #{i["name"]}.#{domain}" unless domain.to_s.strip == ""
+                  list << str
+                  raise HostError.new
+                end
+              end
+            end
+          end
+        rescue HostError; end
+        list
+      end
+    end
+  end
+end

data/lib/gcloud_hosts/options.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+
+module GcloudHosts
+  class Options
+
+    attr_reader :options
+
+    def initialize(args)
+      @options = {
+        gcloud: %x{ which gcloud 2>/dev/null }.to_s.strip,
+        project: nil,
+        network: nil,
+        domain: nil,
+        public: nil,
+        file: '/etc/hosts',
+        backup: nil,
+        dry_run: false,
+        delete: false
+      }
+      parser.parse!(args)
+    end
+
+    private
+
+    def parser
+      @parser ||= begin
+        OptionParser.new do |opts|
+          opts.banner = "Usage: $ gcloud_hosts [options]"
+          opts.on('-g', '--gcloud GCLOUD', "Path to gcloud executable. Defaults to PATH location") do |opt|
+            @options[:project] = opt
+          end
+          opts.on('-p', '--project PROJECT', "gcloud project to use. Defaults to default gcloud configuration.") do |opt|
+            @options[:project] = opt
+          end
+          opts.on('-n', '--network NETWORK', "gcloud network to filter on. Defaults nil.") do |opt|
+            @options[:network] = opt
+          end
+          opts.on('-d', '--domain DOMAIN', "Domain to append to all hosts. Default: \"c.[PROJECT].internal\"") do |opt|
+            @options[:domain] = opt
+          end
+          opts.on('--public PUBLIC', "Pattern to match for public/bastion hosts. Use public IP for these. Defaults to nil") do |opt|
+            @options[:public] = opt
+          end
+          opts.on('-f', '--file FILE', "Hosts file to update. Defaults to /etc/hosts") do |opt|
+            @options[:file] = opt
+          end
+          opts.on('-b', '--backup BACKUP', "Path to backup original hosts file to. Defaults to FILE with '.bak' extension appended.") do |opt|
+            @options[:file] = opt
+          end
+          opts.on('--[no-]dry-run', "Dry run, do not modify hosts file. Defaults to false") do |opt|
+            @options[:dry_run] = opt
+          end
+          opts.on('--[no-]delete', "Delete the project from hosts file. Defaults to false") do |opt|
+            @options[:delete] = opt
+          end
+          opts.on_tail("--help", "Show this message") do
+            puts opts
+            exit
+          end
+          opts.on_tail("--version", "Show version") do
+            puts ::GcloudHosts::VERSION.join('.')
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gcloud_hosts/runner.rb

@@ -0,0 +1,52 @@
+require 'json'
+
+module GcloudHosts
+  class Runner
+
+    def initialize(args)
+      @options = Options.new(args).options
+    end
+
+    def run!
+      project = @options[:project]
+      if project.to_s.strip == ""
+        project = env["core"]["project"]
+      end
+      if project.to_s.strip == ""
+        raise AuthError.new("No gcloud project specified.")
+      end
+
+      if @options[:domain]
+        domain = @options[:domain].to_s.strip
+      else
+        domain = "c.#{project}.internal"
+      end
+
+      backup = @options[:backup] ||
+        @options[:file] + '.bak'
+
+      if @options[:delete]
+        new_hosts_list = []
+      else
+        new_hosts_list = Hosts.hosts(@options[:gcloud], project, @options[:network], domain, @options[:public])
+      end
+      Updater.update(new_hosts_list.join("\n"), project, @options[:file], backup, @options[:dry_run], @options[:delete])
+    end
+
+    private
+
+    def env
+      @env ||= begin
+        gcloud = @options[:gcloud]
+        if gcloud.to_s.strip == ""
+          raise AuthError.new("gcloud command not found.")
+        end
+        env = JSON.parse(%x{ #{gcloud} config list --format json 2>/dev/null })
+        if env["core"]["account"].to_s.strip == ""
+          raise AuthError.new("Please log into gcloud.")
+        end
+        env
+      end
+    end
+  end
+end

data/lib/gcloud_hosts/updater.rb

@@ -0,0 +1,132 @@
+module GcloudHosts
+  # Updater implements a very state machine which is used to update
+  # content between zero or more blocks of content which start and end
+  # with pre-defined "marker" lines.
+  module Updater
+
+    module Marker
+      BEFORE = 0
+      INSIDE = 1
+      AFTER = 2
+    end
+
+    def self.update(new_hosts, project, file, backup_file, dry_run, delete)
+      start_marker = "# START GCLOUD HOSTS - #{project} #"
+      end_marker = "# END GCLOUD HOSTS - #{project} #"
+
+      old_hosts = File.read(file)
+
+      if old_hosts.include?(start_marker) && old_hosts.include?(end_marker)
+        # valid markers exists
+        if delete
+          new_content = delete_project_hosts(old_hosts, start_marker, end_marker)
+        else
+          new_content = gen_new_hosts(old_hosts, new_hosts, start_marker, end_marker)
+        end
+        # remove zero or more white space characters at end of file with
+        # a single new-line
+        new_content.gsub!(/\s+$/, "\n")
+
+        if dry_run
+          puts new_content
+        elsif new_content != old_hosts
+          # backup old host file
+          File.open(backup_file, 'w') { |f| f << old_hosts }
+          # write new content
+          File.open(file, 'w') { |f| f << new_content }
+        end
+      elsif old_hosts.include?(start_marker) || old_hosts.include?(end_marker)
+        raise UpdaterError.new("Invalid marker present in existing hosts content")
+      else
+        # marker doesn't exist
+        if delete
+          new_content = old_hosts
+        else
+          new_content = [old_hosts, start_marker, new_hosts, end_marker].join("\n")
+        end
+        # remove one or more white space characters at end of file with
+        # a single new-line
+        new_content.gsub!(/\s+$/, "\n")
+
+        if dry_run
+          puts new_content
+        elsif new_content != old_hosts
+          # backup old host file
+          File.open(backup_file, 'w') { |f| f << old_hosts }
+          # write new content
+          File.open(file, 'w') { |f| f << new_content }
+        end
+      end
+
+      true
+    end
+
+    def self.gen_new_hosts(hosts, new_hosts, start_marker, end_marker)
+      new_content = ''
+      marker_state = Marker::BEFORE
+      hosts.split("\n").each do |line|
+        if line == start_marker
+          if marker_state == Marker::BEFORE
+            # transition to inside the marker
+            new_content << start_marker + "\n"
+            marker_state = Marker::INSIDE
+            # add new host content
+            new_hosts.split("\n").each do |host|
+              new_content << host + "\n"
+            end
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        elsif line == end_marker
+          if marker_state == Marker::INSIDE
+            # transition to after the marker
+            new_content << end_marker + "\n"
+            marker_state = Marker::AFTER
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        else
+          case marker_state
+          when Marker::BEFORE, Marker::AFTER
+            new_content << line + "\n"
+          when Marker::INSIDE
+            # skip everything between old markers
+            next
+          end
+        end
+      end
+      new_content
+    end
+
+    def self.delete_project_hosts(hosts, start_marker, end_marker)
+      new_content = ''
+      marker_state = Marker::BEFORE
+      hosts.split("\n").each do |line|
+        if line == start_marker
+          if marker_state == Marker::BEFORE
+            marker_state = Marker::INSIDE
+            # don't add any content, we're deleting this block
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        elsif line == end_marker
+          if marker_state == Marker::INSIDE
+            marker_state = Marker::AFTER
+          else
+            raise UpdaterError.new("Invalid marker state")
+          end
+        else
+          case marker_state
+          when Marker::BEFORE, Marker::AFTER
+            new_content << line + "\n"
+          when Marker::INSIDE
+            # skip everything between old markers
+            next
+          end
+        end
+      end
+      new_content
+    end
+
+  end
+end

data/lib/gcloud_hosts/version.rb

@@ -0,0 +1,3 @@
+module GcloudHosts
+  VERSION = "0.1.0"
+end

data/lib/gcloud_hosts.rb

@@ -0,0 +1,11 @@
+require 'gcloud_hosts/version'
+require 'gcloud_hosts/options'
+require 'gcloud_hosts/hosts'
+require 'gcloud_hosts/updater'
+require 'gcloud_hosts/runner'
+
+module GcloudHosts
+  class HostError < StandardError; end
+  class UpdaterError < StandardError; end
+  class AuthError < StandardError; end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: gcloud_hosts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Tongen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Update your hosts file based on gcloud compute instances
+email:
+- atongen@gmail.com
+executables:
+- gcloud_hosts
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/gcloud_hosts
+- gcloud_hosts.gemspec
+- lib/gcloud_hosts.rb
+- lib/gcloud_hosts/hosts.rb
+- lib/gcloud_hosts/options.rb
+- lib/gcloud_hosts/runner.rb
+- lib/gcloud_hosts/updater.rb
+- lib/gcloud_hosts/version.rb
+homepage: https://github.com/atongen/gcloud_hosts
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Update your hosts file based on gcloud compute instances
+test_files: []
+has_rdoc: