devbox_launcher 0.3.4 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d79623bafc3e14c6b9f9f58a8031282a334d8ea833e188546d1bffa4ffc1c10
-  data.tar.gz: 350a59f18358ba1c473aed63dd033b3699b658e69a02d63bd7d29306a57bd695
+  metadata.gz: 51aeda9106ca067ea8ceb40899eeced91677bebb5de13b036280190d22980e16
+  data.tar.gz: b2852f7051db8ec6c4ce7e071aa256cab13b64af69455a774d4d18e9b949db75
 SHA512:
-  metadata.gz: d25e43064171246a712be3a2ab71d2b30d5a3a58891bdeb84538293004147ed6a2b5f7bea5054e66cf433b5a47c0bce154a9aa2649e863e282c5a4a9d95a89dd
-  data.tar.gz: 59102e2931d6327865ddc9bb87706dd31bffd703b618a7c9b05735062ac4c0cf69852b9b70be89223f99ee8f82858ceeb6091f7d784b3f43339402f9b070731f
+  metadata.gz: c84b3cb6f48286ea756546429c3e2d6bf6121b0f4632207bf37779e1f0a4611eb4126b6d24645a81b34738cb178c3cc06ec3046c606fa92a8bc65a71665474b0
+  data.tar.gz: 2585520ba4fb389c731b9f8fcca88b453ac6dbb91e82b9a466341d32e68ee773a42b481f106a400d1d5f5ea31b12358db098fb53f7ae6e6312cd7ec117a6b500

data/CHANGELOG.md

@@ -4,6 +4,29 @@ 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.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
+
+## [0.3.5]
+### Fixed
+- When running commands, also rescue from whitelist of exceptions, and retry
+
 ## [0.3.4]
 ### Added
 - Rescue from `Errno::ECONNREFUSED` and retry

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devbox_launcher (0.3.4)
+    devbox_launcher (0.5.2)
       activesupport (~> 6.0)
       bcrypt_pbkdf (~> 1.0)
       ed25519 (~> 1.2)
@@ -14,31 +14,31 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.1)
+    activesupport (6.1.3.2)
       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.6)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
     ed25519 (1.2.4)
-    i18n (1.8.2)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
-    minitest (5.14.1)
+    minitest (5.14.4)
     net-ssh (5.2.0)
-    os (1.1.0)
+    os (1.1.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     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.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
+    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
 
@@ -21,6 +17,9 @@ 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
@@ -36,7 +35,7 @@ To start and create the mutagen session:
 devbox start your-username
 ```
 
-If you want to mosh in immediately, add the `--mosh` switch.
+If you want to mosh in immediately, add the `--mosh` switch. Yes, mosh needs to be [installed](https://mosh.org/) in your development machine.
 
 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.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"

data/lib/devbox_launcher/models/box.rb

@@ -6,9 +6,10 @@ 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
@@ -35,21 +36,7 @@ module DevboxLauncher
     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
@@ -82,8 +69,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,21 +84,7 @@ 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!
@@ -218,5 +189,26 @@ module DevboxLauncher
       @mutagen_config ||= Mutagen.new(config[:mutagen])
     end
 
+    def cmd_args_for(method)
+      args = {
+        project: config[:project],
+        account: account,
+        zone: 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/version.rb

@@ -1,3 +1,3 @@
 module DevboxLauncher
-  VERSION = "0.3.4"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devbox_launcher
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.5.2
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2021-05-31 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,7 +189,6 @@ files:
 - bin/setup
 - devbox_launcher.gemspec
 - lib/devbox_launcher.rb
-- lib/devbox_launcher/box.rb
 - lib/devbox_launcher/cli.rb
 - lib/devbox_launcher/models/box.rb
 - lib/devbox_launcher/models/description.rb
@@ -219,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Conveniently launch your devbox

data/lib/devbox_launcher/box.rb

@@ -1,206 +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 =
-        Open3.capture3(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 =
-        Open3.capture3(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 =
-        Open3.capture3(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}",
-      ]
-      create_mutagen_command << "--watch-mode-alpha=no-watch" if OS.linux?
-
-      create_mutagen_stdout,
-        create_mutagen_stderr,
-        create_mutagen_status =
-        Open3.capture3(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
-
-  end
-end