devbox_launcher 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d2b9f957cb18b171f3d4acc9d802576b1bd768eb6afa6036ae23143b9403ab1
-  data.tar.gz: f0dc90ba120f6d34f42b0432b53728bd9caf40468262091dd2c88e15bdc16fcf
+  metadata.gz: c247836992ba6c6f8b7dc733aca134394ea41eaf0ccf1026e72837992d77aa57
+  data.tar.gz: 7fde1e5aeff66e1b199d9b1bac17d80368c50d90eb74cd7ddf29fa9923122886
 SHA512:
-  metadata.gz: ba367cf32efeef9ac13b46c9c3af638b1998ff7c335a458c4c4421e0c849a043e44fb97d904b69428936393fdc1754adef71ead9197c46d96beacb25e6bee909
-  data.tar.gz: 5b7b7216addc48d9982e9706069a7ecf293e5543f3d11c4aff7997882b2f274ab0fe3bbf6b98b1833008cc9354b8753c9e3591756e9df7ad82c949bd353e1cb4
+  metadata.gz: 5bb774576f0003c53c757751b3d502cfedee2f4ef685a0e15031265f80f8d70bcf106f1cd752492f496f1ccce42068d8bceb33219de2b833b0022b1aae348bc2
+  data.tar.gz: d8fe891e797ba651ee5591ee309d6ab51045179746af5b57c88d75e32773321accb2ae60332bf1bc79a4028f2347f3f49493daabf4b9edba176211f69ee7ded8

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.7.0] - 2021-09-23
+### Added
+- Add ability to set a box's user and identity_file
+
+## [0.6.1] - 2021-09-22
+### Fixed
+- Do not blow up if mutagen is not configured
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devbox_launcher (0.5.1)
+    devbox_launcher (0.7.0)
       activesupport (~> 6.0)
       bcrypt_pbkdf (~> 1.0)
       ed25519 (~> 1.2)
@@ -14,7 +14,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,10 +23,10 @@ GEM
     bcrypt_pbkdf (1.1.0)
     byebug (11.0.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
     ed25519 (1.2.4)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
     minitest (5.14.4)

data/README.md

@@ -16,17 +16,17 @@ Create the config file at `~/.devbox_launcher.yml` so you type less. This is an
 
 ```yml
 ramon@email.com:
-  project: general-192303
-  # zone not necessarily required, but sometimes starting the box
-  # fails without this:
-  zone: us-central1-a
-  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
+  - project: development-254604
+    box: ramon
+    user: another_user # only needed if ramon_company_com is not the user
+    identity_file: /path/to/ssh-private # ~/.ssh/google_compute_engine by default
 ```
 
 To start and create the mutagen session:
@@ -35,7 +35,13 @@ To start and create the mutagen session:
 devbox start your-username
 ```
 
-If you want to mosh in immediately, add the `--mosh` switch. Yes, mosh needs to be [installed](https://mosh.org/) in your development machine.
+- 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/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,25 @@ module DevboxLauncher
       Net::SSH::Disconnect,
       Errno::ECONNRESET,
       Errno::ETIMEDOUT,
+      Errno::ECONNREFUSED,
     ]
     WAIT_BOOT_IN_SECONDS = 10.freeze
-    MAX_BOOT_RETRIES = 10
-    DEFAULT_IDENTIFY_FILE_PATH = "~/.ssh/google_compute_engine".freeze
+    MAX_BOOT_RETRIES = 20
     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,7 +35,7 @@ module DevboxLauncher
 
       reset_mutagen_session
 
-      connect_mosh
+      connect_mosh || connect_ssh
     end
 
     def start_cmd
@@ -45,6 +49,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"
@@ -68,8 +79,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)
 
@@ -90,16 +99,16 @@ module DevboxLauncher
 
     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,
+        "IdentityFile" => box_config.identity_file,
       }
       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
@@ -164,8 +173,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
@@ -173,28 +205,32 @@ module DevboxLauncher
     end
 
     def username
-      @username ||= account.gsub(/\W/, "_")
+      @username ||= box_config.user || 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: config[:project],
+        project: box_config.project,
         account: account,
-        zone: config[:zone],
+        zone: box_config.zone,
       }.each_with_object([]) do |(key, val), arr|
         next if val.blank?
         arr << ["--#{key}", val].join("=")

data/lib/devbox_launcher/models/box_config.rb

@@ -0,0 +1,33 @@
+module DevboxLauncher
+  class BoxConfig
+
+    DEFAULT_IDENTIFY_FILE_PATH = "~/.ssh/google_compute_engine".freeze
+
+    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
+
+    def user
+      config[:user]
+    end
+
+    def identity_file
+      config[:identity_file] || DEFAULT_IDENTIFY_FILE_PATH
+    end
+
+  end
+end

data/lib/devbox_launcher/models/mutagen.rb

@@ -8,7 +8,8 @@ module DevboxLauncher
     end
 
     def configured?
-      [config, alpha_dir, beta_dir].none?(&:nil?)
+      return false if config.nil?
+      [alpha_dir, beta_dir].all?(&:present?)
     end
 
     def alpha_dir

data/lib/devbox_launcher/version.rb

@@ -1,3 +1,3 @@
 module DevboxLauncher
-  VERSION = "0.5.1"
+  VERSION = "0.7.0"
 end

data/lib/devbox_launcher.rb

@@ -20,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.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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