devbox_launcher 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c48092de409744a2c52020e6caf65cf2d06377ab686aca517ede0b9790b0d414
-  data.tar.gz: 7cdae080f466ead661718d23bc320f424049cc118887aab9402d5043f0d05184
+  metadata.gz: f36523ab1ba2737746a95069dc0bd49e1e182b9449ff8af6ad7ba2c8eba6fac5
+  data.tar.gz: 4d9ec6e2cf0df27fe3ae57d2860312272140a238ab43b460dc1b8b706982f77b
 SHA512:
-  metadata.gz: 32574d16bae08ed7470449b7c36cdd6acc9f76b176e9e5342b9a70a49da9001debee5ee4793bb0295221606e07158e6aa20984f7d762d462bd8fbfb69ec36923
-  data.tar.gz: 94fee4aa07ef525c2b5c4de214bc2452aa7c8c8f9a2e7a43103d0a0c6e9c3a6c72f76bbe66a93601006d8532efe46b42a211a9d2fbdc96c194907f800d8ff257
+  metadata.gz: 272f2e79480f5439a98797833bb21709ca4137a04f3ea46b0a70b3c473ccac66a0e53e688699923d2a71fed52e11bc704f3ff08fbefb41d86888bc35388251d5
+  data.tar.gz: 0321766ede0a716eb6e3d3745213ea2e810cfd74b3fde853dc98627354ac92f610e5983e50f043812eab0d6fb017784801b0780d204a6640ef5dbc29b22194dd

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).
 
+## [1.0.0] - 2021-12-20
+### Changed
+- Update compatibility with mutagen 0.12.0. Drops support for previous versions
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devbox_launcher (0.6.0)
+    devbox_launcher (1.0.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.4.1)
+    activesupport (6.1.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -26,12 +26,12 @@ GEM
     concurrent-ruby (1.1.9)
     diff-lcs (1.3)
     ed25519 (1.2.4)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
-    minitest (5.14.4)
+    minitest (5.15.0)
     net-ssh (5.2.0)
-    os (1.1.1)
+    os (1.1.4)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -57,7 +57,7 @@ GEM
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -70,4 +70,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.28

data/README.md

@@ -23,8 +23,10 @@ ramon@email.com:
       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:

data/lib/devbox_launcher/models/box.rb

@@ -10,7 +10,6 @@ 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
@@ -34,7 +33,7 @@ module DevboxLauncher
 
       wait_boot
 
-      reset_mutagen_session
+      mutagen_session.reset
 
       connect_mosh || connect_ssh
     end
@@ -104,7 +103,7 @@ module DevboxLauncher
       args = {
         "HostName" => description.ip,
         "User" => username,
-        "IdentityFile" => DEFAULT_IDENTIFY_FILE_PATH,
+        "IdentityFile" => box_config.identity_file,
       }
       args.each do |key, value|
         ssh_config.set(hostname, key, value)
@@ -112,68 +111,10 @@ module DevboxLauncher
       ssh_config.save
     end
 
-    def reset_mutagen_session
-      return if !mutagen_config.configured?
-
-      terminate_mutagen_session
-      create_mutagen_session
-      watch_alpha if OS.linux?
-    end
-
-    def terminate_mutagen_session
-      puts "Terminating mutagen session..."
-      terminate_mutagen_cmd =
-        %Q(mutagen terminate --label-selector=#{label})
-      terminate_mutagen_stdout,
-        terminate_mutagen_stderr,
-        terminate_mutagen_status =
-        Open3.capture3(terminate_mutagen_cmd)
-
-      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 label
       "#{username}=#{name}"
     end
 
-    def create_mutagen_session
-      puts "Create mutagen session syncing local " \
-        "#{mutagen_config.alpha_dir} with " \
-        "#{hostname} #{mutagen_config.beta_dir}"
-
-      create_mutagen_cmd = [
-        "mutagen sync create",
-        mutagen_config.alpha_dir,
-        "#{hostname}:#{mutagen_config.beta_dir}",
-        "--label=#{label}",
-      ]
-      create_mutagen_cmd << "--watch-mode-alpha=no-watch" if OS.linux?
-
-      create_mutagen_stdout,
-        create_mutagen_stderr,
-        create_mutagen_status =
-        Open3.capture3(create_mutagen_cmd.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
-      watchman = Watchman.new(dir: mutagen_config.alpha_dir)
-      watchman.trigger("mutagen sync flush --label-selector=#{label}")
-    end
-
     def box_name_from_config
       passed_in_box_name = @account_and_box_name.split("/")[1]
 
@@ -206,7 +147,7 @@ module DevboxLauncher
     end
 
     def username
-      @username ||= account.gsub(/\W/, "_")
+      @username ||= box_config.user || account.gsub(/\W/, "_")
     end
 
     def account_config
@@ -247,6 +188,13 @@ module DevboxLauncher
       ].join(" ")
     end
 
+    def mutagen_session
+      @mutagen_session ||= MutagenSession.new(
+        label: label,
+        config: mutagen_config,
+        hostname: hostname,
+      )
+    end
 
   end
 end

data/lib/devbox_launcher/models/box_config.rb

@@ -1,6 +1,8 @@
 module DevboxLauncher
   class BoxConfig
 
+    DEFAULT_IDENTIFY_FILE_PATH = "~/.ssh/google_compute_engine".freeze
+
     attr_reader :config
 
     def initialize(config)
@@ -8,7 +10,7 @@ module DevboxLauncher
     end
 
     def mutagen_config
-      Mutagen.new(config[:mutagen])
+      MutagenConfig.new(config[:mutagen])
     end
 
     def project
@@ -19,5 +21,13 @@ module DevboxLauncher
       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/models/mutagen_config.rb

@@ -0,0 +1,24 @@
+module DevboxLauncher
+  class MutagenConfig
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def configured?
+      return false if config.nil?
+      [alpha_dir, beta_dir].all?(&:present?)
+    end
+
+    def alpha_dir
+      config[:alpha]
+    end
+
+    def beta_dir
+      config[:beta]
+    end
+
+  end
+end

data/lib/devbox_launcher/models/mutagen_session.rb

@@ -0,0 +1,83 @@
+module DevboxLauncher
+  class MutagenSession
+
+    attr_reader :label, :config, :hostname
+
+    def initialize(label:, config:, hostname:)
+      @label = label
+      @config = config
+      @hostname = hostname
+    end
+
+    def create
+      puts "Create mutagen session syncing local " \
+        "#{config.alpha_dir} with " \
+        "#{hostname} #{config.beta_dir}"
+
+      create_stdout,
+        create_stderr,
+        create_status =
+        Open3.capture3(create_cmd)
+
+      if not create_status.success?
+        # mutagen prints to stdout and stderr
+        msg = "Failed to create mutagen sessions: " \
+          "#{create_stdout} -" \
+          "#{create_stderr}"
+        fail msg
+      end
+    end
+
+    def linux?
+      OS.linux?
+    end
+
+    def create_cmd
+      str = [
+        "mutagen sync create",
+        config.alpha_dir,
+        "#{hostname}:#{config.beta_dir}",
+        "--label=#{label}",
+      ]
+      str << "--watch-mode-alpha=no-watch" if linux?
+      str.join(" ")
+    end
+
+    def terminate_cmd
+      %Q(mutagen sync terminate --label-selector=#{label})
+    end
+
+    def terminate
+      puts "Terminating mutagen session..."
+      terminate_stdout,
+        terminate_stderr,
+        terminate_status =
+        Open3.capture3(terminate_cmd)
+
+      if not terminate_status.success?
+        # mutagen prints to stdout and stderr
+        msg = "Failed to terminate mutagen sessions: " \
+          "#{terminate_stdout} -" \
+          "#{terminate_stderr}"
+        fail msg
+      end
+    end
+
+    def watch_alpha
+      watchman.trigger("mutagen sync flush --label-selector=#{label}")
+    end
+
+    def watchman
+      @watchman ||= Watchman.new(dir: config.alpha_dir)
+    end
+
+    def reset
+      return if !config.configured?
+
+      terminate
+      create
+      watch_alpha if linux?
+    end
+
+  end
+end

data/lib/devbox_launcher/version.rb

@@ -1,3 +1,3 @@
 module DevboxLauncher
-  VERSION = "0.6.0"
+  VERSION = "1.0.0"
 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"
@@ -18,7 +19,8 @@ end
 require "devbox_launcher/cli"
 require "devbox_launcher/watchman"
 require "devbox_launcher/models/description"
-require "devbox_launcher/models/mutagen"
+require "devbox_launcher/models/mutagen_config"
+require "devbox_launcher/models/mutagen_session"
 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.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -195,6 +195,8 @@ files:
 - lib/devbox_launcher/models/box_config.rb
 - lib/devbox_launcher/models/description.rb
 - lib/devbox_launcher/models/mutagen.rb
+- lib/devbox_launcher/models/mutagen_config.rb
+- lib/devbox_launcher/models/mutagen_session.rb
 - lib/devbox_launcher/version.rb
 - lib/devbox_launcher/watchman.rb
 homepage: https://github.com/bloom-solutions/devbox_launcher