devbox_launcher 0.5.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51aeda9106ca067ea8ceb40899eeced91677bebb5de13b036280190d22980e16
-  data.tar.gz: b2852f7051db8ec6c4ce7e071aa256cab13b64af69455a774d4d18e9b949db75
+  metadata.gz: 73bbdd9915f666e004ef152b8749e333face998265474ecddbf5d01f55a30f01
+  data.tar.gz: af3b044ffff0318f3fdf622ef688685c7eba44068976703e32255038d79f26ea
 SHA512:
-  metadata.gz: c84b3cb6f48286ea756546429c3e2d6bf6121b0f4632207bf37779e1f0a4611eb4126b6d24645a81b34738cb178c3cc06ec3046c606fa92a8bc65a71665474b0
-  data.tar.gz: 2585520ba4fb389c731b9f8fcca88b453ac6dbb91e82b9a466341d32e68ee773a42b481f106a400d1d5f5ea31b12358db098fb53f7ae6e6312cd7ec117a6b500
+  metadata.gz: fb0e7f1d59c4a81faa72586cb618d24f3dc75f1a04711427a74846e34ab2fda3df2dac8098211d7734b3d3b5f4c010c6683a5f12efb36c8e13c30ace73291e70
+  data.tar.gz: 5d558bf0456db555941e8e5b6bf498af28280420f86dd0d2e3b438819a878528889cda7155a8e5050116a783a6f16dec3d47b2704238bbdd5a19230902a130e3

data/CHANGELOG.md

@@ -4,6 +4,22 @@ 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.1] - 2021-10-14
+### Fixed
+- Explicitly require fileutils for Ruby 3.0 compatibility
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devbox_launcher (0.5.2)
+    devbox_launcher (0.7.1)
       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.2)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,7 +23,7 @@ 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.10)
@@ -70,4 +70,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.27

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

@@ -10,18 +10,21 @@ module DevboxLauncher
     ]
     WAIT_BOOT_IN_SECONDS = 10.freeze
     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)
@@ -32,7 +35,7 @@ module DevboxLauncher
 
       reset_mutagen_session
 
-      connect_mosh
+      connect_mosh || connect_ssh
     end
 
     def start_cmd
@@ -46,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"
@@ -89,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
@@ -163,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
@@ -172,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.2"
+  VERSION = "0.7.1"
 end

data/lib/devbox_launcher.rb

@@ -3,6 +3,7 @@ require "active_support/core_ext/object/blank"
 require "ssh-config"
 require "open3"
 require "thor"
+require "fileutils"
 require "net/ssh"
 require "os"
 require "ruby-watchman"
@@ -20,3 +21,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.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -190,7 +190,9 @@ files:
 - devbox_launcher.gemspec
 - lib/devbox_launcher.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
@@ -218,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