devbox_launcher 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb4a378b2f76aac6847c19aa98173e0ec1eaa4dd94ee5983dce3b2b2025ff989
-  data.tar.gz: e0185ccc0c83c43091399da51229fe7f677b6bf295362449b81deca893a359a5
+  metadata.gz: c48092de409744a2c52020e6caf65cf2d06377ab686aca517ede0b9790b0d414
+  data.tar.gz: 7cdae080f466ead661718d23bc320f424049cc118887aab9402d5043f0d05184
 SHA512:
-  metadata.gz: 00dcd892ade882a93cc908451b6ed9dedb229160f55f28a9aa2735e573aafae7732e6df4221fbf06d0669060f5ec4082d331de908917ae172a0157c84cef001b
-  data.tar.gz: dee55da84e14e426fdc605201725f3ddb0d9525e9838edbae1a8af62438420040d51a48cda06cac2e898383b3b85bfa8d62355148f63ab2870373cb942198901
+  metadata.gz: 32574d16bae08ed7470449b7c36cdd6acc9f76b176e9e5342b9a70a49da9001debee5ee4793bb0295221606e07158e6aa20984f7d762d462bd8fbfb69ec36923
+  data.tar.gz: 94fee4aa07ef525c2b5c4de214bc2452aa7c8c8f9a2e7a43103d0a0c6e9c3a6c72f76bbe66a93601006d8532efe46b42a211a9d2fbdc96c194907f800d8ff257

data/CHANGELOG.md

@@ -4,6 +4,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.0] - 2021-09-21
+### Changed
+- Ability to configure multiple boxes under one account
+
+## [0.5.2] - 2021-05-31
+### Added
+- Ignore VCS as recommended by mutagen
+
+### Fixed
+- Retry on `Errno::ECONNREFUSED`
+
+## [0.5.1] - 2021-04-08
+### Fixed
+- Use configured `zone` for describe as well
+
+## [0.5.0] - 2021-04-06
+### Added
+- Ability to specify `zone` in config
+
 ## [0.4.0]
 ### Added
 - Sync mutagen with two-way-resolved

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devbox_launcher (0.3.5)
+    devbox_launcher (0.6.0)
       activesupport (~> 6.0)
       bcrypt_pbkdf (~> 1.0)
       ed25519 (~> 1.2)
@@ -14,22 +14,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    bcrypt_pbkdf (1.0.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    bcrypt_pbkdf (1.1.0)
     byebug (11.0.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
     ed25519 (1.2.4)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
-    minitest (5.14.2)
+    minitest (5.14.4)
     net-ssh (5.2.0)
     os (1.1.1)
     pry (0.12.2)
@@ -38,7 +38,7 @@ GEM
     pry-byebug (3.7.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -54,11 +54,10 @@ GEM
     rspec-support (3.9.0)
     ruby-watchman (0.0.2)
     ssh-config (0.1.3)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -67,7 +66,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   devbox_launcher!
   pry-byebug
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -4,13 +4,9 @@ Start devboxes quickly
 
 ## Installation
 
-Install the gem:
-
-```sh
-gem install devbox_launcher
-```
-
-Setup gcloud init with the project that contains your VM.
+- Install the gem: `gem install devbox_launcher`
+- Setup `gcloud init` with the project that contains your VM
+- Install [mutagen](https://mutagen.io)
 
 ## Usage
 
@@ -20,11 +16,12 @@ Create the config file at `~/.devbox_launcher.yml` so you type less. This is an
 
 ```yml
 ramon@email.com:
-  project: general-192303
-  box: your-instance-name
-  mutagen:
-    alpha: /mnt/c/Users/me/src # local machine
-    beta: ~/src # remote machine
+  - box: your-instance-name
+    project: general-192303
+    zone: us-central1-a
+    mutagen:
+      alpha: /mnt/c/Users/me/src # local machine
+      beta: ~/src # remote machine
 ramon@company.com:
   project: development-254604
   box: ramon
@@ -36,7 +33,13 @@ To start and create the mutagen session:
 devbox start your-username
 ```
 
-If you want to mosh in immediately, add the `--mosh` switch.
+- Want to ssh in immediately?
+  - Add `--ssh` switch
+- Want to mosh in immediately?
+  - Add `--mosh` switch. Mosh needs to be [installed](https://mosh.org/) in your development machine.
+- More than one box with the same Google Cloud account?
+  - Pass in the box in your command, via `devbox start user@domain.com/box-name`
+  - No need to configure `box:` in the YAML file
 
 Note: Linux users that sync mutagen sessions need to install [Watchman](https://facebook.github.io/watchman/).
 

data/devbox_launcher.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_runtime_dependency "thor", "~> 1.0"

data/lib/devbox_launcher/cli.rb

@@ -9,6 +9,7 @@ module DevboxLauncher
 
     desc "start configured box for account", "Start a devbox by account"
     option :mosh, type: :boolean, desc: "Mosh in"
+    option :ssh, type: :boolean, desc: "SSH in"
 
     def start(account)
       Box.new(account, options).start

data/lib/devbox_launcher/models/account_config.rb

@@ -0,0 +1,22 @@
+module DevboxLauncher
+  class AccountConfig
+
+    attr_reader :account_name
+
+    def initialize(account_name, config)
+      @account_name = account_name
+      @config = config
+    end
+
+    def find_box_config(box_name)
+      box_config = @config.find { |c| c["box"] == box_name }
+
+      if box_config.nil?
+        fail "No box config found for #{box_name} under account #{account_name}"
+      end
+
+      BoxConfig.new(box_config)
+    end
+
+  end
+end

data/lib/devbox_launcher/models/box.rb

@@ -6,21 +6,26 @@ module DevboxLauncher
       Net::SSH::Disconnect,
       Errno::ECONNRESET,
       Errno::ETIMEDOUT,
+      Errno::ECONNREFUSED,
     ]
     WAIT_BOOT_IN_SECONDS = 10.freeze
-    MAX_BOOT_RETRIES = 10
+    MAX_BOOT_RETRIES = 20
     DEFAULT_IDENTIFY_FILE_PATH = "~/.ssh/google_compute_engine".freeze
     SSH_CONFIG_PATH = File.expand_path("~/.ssh/config").freeze
     CONFIG_PATH = File.expand_path("~/.devbox_launcher.yml").freeze
     CONFIG = YAML.load_file(CONFIG_PATH).freeze
 
-    attr_reader :account, :options
+    attr_reader :account_and_box_name, :options
 
-    def initialize(account, options)
-      @account = account
+    def initialize(account_and_box_name, options)
+      @account_and_box_name = account_and_box_name
       @options = options
     end
 
+    def account
+      @account ||= @account_and_box_name.split("/")[0]
+    end
+
     def start
       start_stdout, start_stderr, start_status =
         Open3.capture3(start_cmd)
@@ -31,25 +36,11 @@ module DevboxLauncher
 
       reset_mutagen_session
 
-      connect_mosh
+      connect_mosh || connect_ssh
     end
 
     def start_cmd
-      args = {
-        project: config[:project],
-        account: account,
-      }.map do |(key, val)|
-        ["--#{key}", val].join("=")
-      end.join(" ")
-
-      [
-        "gcloud",
-        "compute",
-        "instances",
-        "start",
-        name,
-        args
-      ].join(" ")
+      cmd_args_for('start')
     end
 
     def connect_mosh
@@ -59,6 +50,13 @@ module DevboxLauncher
       system(mosh_cmd)
     end
 
+    def connect_ssh
+      return if options[:ssh].nil?
+
+      ssh_cmd = %Q(ssh #{hostname})
+      system(ssh_cmd)
+    end
+
     def wait_boot(tries: 1)
       Net::SSH.start(hostname, username, timeout: WAIT_BOOT_IN_SECONDS) do |ssh|
         puts "[#{ssh.exec!('date').chomp}] Machine booted"
@@ -82,8 +80,6 @@ module DevboxLauncher
     def description(reload: false)
       return @description if !reload && @description
 
-      puts "Fetching box's description..."
-
       describe_stdout, describe_stderr, describe_status =
         Open3.capture3(describe_cmd)
 
@@ -99,35 +95,21 @@ module DevboxLauncher
     end
 
     def describe_cmd
-      args = {
-        project: config[:project],
-        account: account,
-      }.map do |(key, val)|
-        ["--#{key}", val].join("=")
-      end.join(" ")
-
-      [
-        "gcloud",
-        "compute",
-        "instances",
-        "describe",
-        name,
-        args
-      ].join(" ")
+      cmd_args_for('describe')
     end
 
     def set_ssh_config!
       FileUtils.touch(SSH_CONFIG_PATH)
-      config = ConfigFile.new
+      ssh_config = ConfigFile.new
       args = {
         "HostName" => description.ip,
         "User" => username,
         "IdentityFile" => DEFAULT_IDENTIFY_FILE_PATH,
       }
       args.each do |key, value|
-        config.set(hostname, key, value)
+        ssh_config.set(hostname, key, value)
       end
-      config.save
+      ssh_config.save
     end
 
     def reset_mutagen_session
@@ -192,8 +174,31 @@ module DevboxLauncher
       watchman.trigger("mutagen sync flush --label-selector=#{label}")
     end
 
+    def box_name_from_config
+      passed_in_box_name = @account_and_box_name.split("/")[1]
+
+      case account_config.count
+      when 0
+        fail "You have to specify box configuration"
+      when 1
+        account_config.first[:box]
+      else
+        account_config[name]
+      end
+    end
+
     def name
-      @name ||= config[:box]
+      return @name if @name
+      passed_in_box_name = @account_and_box_name.split("/")[1]
+
+      name = passed_in_box_name.presence || box_name_from_config
+
+      if name.blank?
+        fail "box name must be given either in the CLI or in config. " \
+          "See README.md."
+      end
+
+      @name = name
     end
 
     def hostname
@@ -204,19 +209,44 @@ module DevboxLauncher
       @username ||= account.gsub(/\W/, "_")
     end
 
-    def config
-      return @config if @config
+    def account_config
+      return @account_config if @account_config
 
       if not CONFIG.has_key?(account)
         fail "No config in #{CONFIG_PATH} found for #{account}"
       end
 
-      @config = CONFIG[account].with_indifferent_access
+      @account_config = AccountConfig.new(account, CONFIG[account])
+    end
+
+    def box_config
+      account_config.find_box_config(name)
     end
 
     def mutagen_config
-      @mutagen_config ||= Mutagen.new(config[:mutagen])
+      @mutagen_config ||= box_config.mutagen_config
+    end
+
+    def cmd_args_for(method)
+      args = {
+        project: box_config.project,
+        account: account,
+        zone: box_config.zone,
+      }.each_with_object([]) do |(key, val), arr|
+        next if val.blank?
+        arr << ["--#{key}", val].join("=")
+      end.join(" ")
+
+      [
+        "gcloud",
+        "compute",
+        "instances",
+        method,
+        name,
+        args
+      ].join(" ")
     end
 
+
   end
 end

data/lib/devbox_launcher/models/box_config.rb

@@ -0,0 +1,23 @@
+module DevboxLauncher
+  class BoxConfig
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config.with_indifferent_access
+    end
+
+    def mutagen_config
+      Mutagen.new(config[:mutagen])
+    end
+
+    def project
+      config[:project]
+    end
+
+    def zone
+      config[:zone]
+    end
+
+  end
+end

data/lib/devbox_launcher/version.rb

@@ -1,3 +1,3 @@
 module DevboxLauncher
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/devbox_launcher.rb

@@ -1,4 +1,5 @@
 require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/blank"
 require "ssh-config"
 require "open3"
 require "thor"
@@ -19,3 +20,5 @@ require "devbox_launcher/watchman"
 require "devbox_launcher/models/description"
 require "devbox_launcher/models/mutagen"
 require "devbox_launcher/models/box"
+require "devbox_launcher/models/account_config"
+require "devbox_launcher/models/box_config"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devbox_launcher
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -189,9 +189,10 @@ files:
 - bin/setup
 - devbox_launcher.gemspec
 - lib/devbox_launcher.rb
-- lib/devbox_launcher/box.rb
 - lib/devbox_launcher/cli.rb
+- lib/devbox_launcher/models/account_config.rb
 - lib/devbox_launcher/models/box.rb
+- lib/devbox_launcher/models/box_config.rb
 - lib/devbox_launcher/models/description.rb
 - lib/devbox_launcher/models/mutagen.rb
 - lib/devbox_launcher/version.rb
@@ -219,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Conveniently launch your devbox

data/lib/devbox_launcher/box.rb

@@ -1,214 +0,0 @@
-module DevboxLauncher
-  class Box
-
-    WAIT_BOOT_RESCUED_EXCEPTIONS = [
-      Net::SSH::ConnectionTimeout,
-      Net::SSH::Disconnect,
-      Errno::ECONNRESET,
-      Errno::ETIMEDOUT,
-      Errno::ECONNREFUSED,
-    ]
-    WAIT_BOOT_IN_SECONDS = 10.freeze
-    DEFAULT_IDENTIFY_FILE_PATH = "~/.ssh/google_compute_engine".freeze
-    SSH_CONFIG_PATH = File.expand_path("~/.ssh/config").freeze
-    CONFIG_PATH = File.expand_path("~/.devbox_launcher.yml").freeze
-    CONFIG = YAML.load_file(CONFIG_PATH).freeze
-
-    attr_reader :account
-
-    def initialize(account)
-      @account = account
-    end
-
-    def start
-      start_stdout, start_stderr, start_status =
-        run_command(start_cmd)
-
-      set_ssh_config!(hostname, {
-        username: username,
-        ip: description.ip,
-      })
-
-      wait_boot
-
-      reset_mutagen_session(
-        mutagen_config: config[:mutagen],
-        hostname: hostname,
-      )
-    end
-
-    def start_cmd
-      args = {
-        project: config[:project],
-        account: account,
-      }.map do |(key, val)|
-        ["--#{key}", val].join("=")
-      end.join(" ")
-
-      [
-        "gcloud",
-        "compute",
-        "instances",
-        "start",
-        name,
-        args
-      ].join(" ")
-    end
-
-    def wait_boot(tries: 1)
-      Net::SSH.start(hostname, username, timeout: WAIT_BOOT_IN_SECONDS) do |ssh|
-        puts "[#{ssh.exec!('date').chomp}] Machine booted"
-      end
-    rescue *WAIT_BOOT_RESCUED_EXCEPTIONS
-      puts "Not booted. Waiting #{WAIT_BOOT_IN_SECONDS} seconds before trying again..."
-
-      sleep WAIT_BOOT_IN_SECONDS
-
-      description = describe(name)
-      if !description.running?
-        puts "Detected that the machine is not running " \
-          "(status is #{description.status}). Booting it..."
-        start_box name, username
-      end
-
-      wait_boot name, username, tries: tries+1
-    end
-
-    def description(reload: false)
-      return @description if !reload && @description
-
-      puts "Fetching box's description..."
-
-      describe_command = %Q(gcloud compute instances describe #{name})
-      describe_stdout, describe_stderr, describe_status =
-        run_command(describe_command)
-
-      if !describe_status.success?
-        msg = "Problem fetching the description of #{name}. "
-        msg += "Please ensure you can call `#{describe_command}`.\n"
-        msg += "Error:\n"
-        msg += describe_stderr
-        fail msg
-      end
-
-      @description = Description.new(describe_stdout)
-    end
-
-    def set_ssh_config!(hostname, username:, ip:)
-      FileUtils.touch(SSH_CONFIG_PATH)
-      config = ConfigFile.new
-      args = {
-        "HostName" => ip,
-        "User" => username,
-        "IdentityFile" => DEFAULT_IDENTIFY_FILE_PATH,
-      }
-      args.each do |key, value|
-        config.set(hostname, key, value)
-      end
-      config.save
-    end
-
-    def reset_mutagen_session
-      mutagen_config = config[:mutagen]
-      return if mutagen_config.nil?
-
-      alpha_dir = mutagen_config[:alpha]
-      beta_dir = mutagen_config[:beta]
-
-      return if alpha_dir.nil? || beta_dir.nil?
-
-      terminate_mutagen_session
-
-      create_mutagen_session(
-        alpha_dir: alpha_dir,
-        beta_dir: beta_dir,
-        hostname: hostname,
-        username: username,
-      )
-
-      if OS.linux?
-        watch_alpha(alpha_dir: alpha_dir, hostname: hostname)
-      end
-    end
-
-    def terminate_mutagen_session(username)
-      puts "Terminating mutagen session..."
-      terminate_mutagen_command =
-        %Q(mutagen terminate --label-selector=#{username})
-      terminate_mutagen_stdout,
-        terminate_mutagen_stderr,
-        terminate_mutagen_status =
-        run_command(terminate_mutagen_command)
-
-      if not terminate_mutagen_status.success?
-        # mutagen prints to stdout and stderr
-        msg = "Failed to terminate mutagen sessions: " \
-          "#{terminate_mutagen_stdout} -" \
-          "#{terminate_mutagen_stderr}"
-        fail msg
-      end
-    end
-
-    def create_mutagen_session(alpha_dir:, beta_dir:, hostname:, username:)
-      puts "Create mutagen session syncing local #{alpha_dir} " \
-        "with #{hostname} #{beta_dir}"
-
-      create_mutagen_command = [
-        "mutagen sync create",
-        alpha_dir,
-        "#{hostname}:#{beta_dir}",
-        "--label=#{username}",
-        "--sync-mode=two-way-resolved",
-      ]
-      create_mutagen_command << "--watch-mode-alpha=no-watch" if OS.linux?
-
-      create_mutagen_stdout,
-        create_mutagen_stderr,
-        create_mutagen_status =
-        run_command(create_mutagen_command.join(" "))
-
-      if not create_mutagen_status.success?
-        # mutagen prints to stdout and stderr
-        msg = "Failed to create mutagen sessions: " \
-          "#{create_mutagen_stdout} -" \
-          "#{create_mutagen_stderr}"
-        fail msg
-      end
-    end
-
-    def watch_alpha(alpha_dir:, hostname:)
-      watchman = Watchman.new(dir: alpha_dir)
-      watchman.trigger("mutagen sync flush --label-selector=#{hostname}")
-    end
-
-    def name
-      @name ||= config[:box]
-    end
-
-    def hostname
-      [name, username, "devbox"].join("-")
-    end
-
-    def username
-      @username ||= account.gsub(/\W/, "_")
-    end
-
-    def config
-      return @config if @config
-
-      if not CONFIG.has_key?(account)
-        fail "No config in #{CONFIG_PATH} found for #{account}"
-      end
-
-      @config = CONFIG[account].with_indifferent_access
-    end
-
-    def run_command(command, tries: 0)
-      Open3.capture3(command)
-    rescue *WAIT_BOOT_RESCUED_EXCEPTIONS
-      sleep WAIT_BOOT_IN_SECONDS
-      run_command(command, tries+1)
-    end
-
-  end
-end