learn-open 1.2.21 → 1.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0d170cc7e2457803701a5055afdd38f3ec5022f23f37b7e1a7d25a994fd5a80
-  data.tar.gz: d598a192eb8111e123d7e9d4fb7b6d82575d86dd48d4c5ca5c40ed1c65aee468
+  metadata.gz: 3c7fb687795b2162c7744bff6b33218bd285534731d1b5f17fc5554b04c9c267
+  data.tar.gz: 0dfd4d3ab154f9866815b51dc774cb910680b152339c936f3f107b54b9cfa471
 SHA512:
-  metadata.gz: 240272e5222130bc341d4e28de8edf12448fcb9ac2562437e0a0d1f39521274a585c17a222807a27cf36dfa74adbf727791490f11e0304c4ae3f981a25eb90b3
-  data.tar.gz: 79ec8c12d8b4f03048a1ec8def1a08a49b02f1a95b001bc3b195272ae006da4dfbda72828074da245fcb2f34194c2ed56c04b01182d49a2620dadb126f4e6619
+  metadata.gz: e16ad1551f023494bf8df4a4f683e7d8e39657f71426661d2182ee9436bed67ac598925daeb4d3c58302badc2178fadab7c78fd996fd5c80a6b8e0b9e842244c
+  data.tar.gz: 952bf6c0e7b04d4633f3bffcfda04b42e9a0ab5b17430189bd51e49cb47a3999d2e984d051f5e58fea61f751d96faf39b0af154c94be73ae6d8980e05b8c3dcc

data/learn-open.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "netrc"
   spec.add_runtime_dependency "git"
-  spec.add_runtime_dependency "learn-web", ">= 1.5.0"
+  spec.add_runtime_dependency "learn-web", ">= 1.5.2"
 end

data/lib/learn_open.rb

@@ -11,6 +11,7 @@ require 'learn_open/argument_parser'
 require 'learn_open/adapters/system_adapter'
 require 'learn_open/adapters/learn_web_adapter'
 require 'learn_open/adapters/io_adapter'
+require 'learn_open/adapters/ssh_adapter'
 require 'learn_open/environments'
 require 'learn_open/environments/base_environment'
 require 'learn_open/environments/mac_environment'
@@ -27,6 +28,7 @@ require 'learn_open/services/dependency_installers/pip_installer'
 require 'learn_open/services/lesson_downloader'
 require 'learn_open/services/file_backup_starter'
 require 'learn_open/services/logger'
+require 'learn_open/services/git_ssh_connector'
 require 'learn_open/lessons'
 require 'learn_open/lessons/base_lesson'
 require 'learn_open/lessons/jupyter_lesson'
@@ -61,6 +63,10 @@ module LearnOpen
     ENV
   end
 
+  def self.ssh_adapter
+    LearnOpen::Adapters::SshAdapter
+  end
+
   def self.system_adapter
     LearnOpen::Adapters::SystemAdapter
   end

data/lib/learn_open/adapters/ssh_adapter.rb

@@ -0,0 +1,44 @@
+module LearnOpen
+  module Adapters
+    class SshAdapter
+      attr_reader :user, :hostname
+
+      SSH_AUTH_SUCCESS_EXIT_STATUS = 1
+      SSH_AUTH_FAILURE_EXIT_STATUS = 255
+
+      def initialize(user:, hostname:)
+        @user = user
+        @hostname = hostname
+      end
+
+      def public_key
+        File.read("#{ENV['HOME']}/.ssh/id_rsa.pub").chomp
+      end
+
+      def unauthenticated?
+        !authenticated?
+      end
+
+      def authenticated?
+        _stdout, stderr, status = LearnOpen.system_adapter.run_command_with_capture("ssh -T #{user}@#{hostname}")
+
+        case status.exitstatus
+        when SSH_AUTH_SUCCESS_EXIT_STATUS
+          true
+        when SSH_AUTH_FAILURE_EXIT_STATUS
+          case stderr
+          when /permission denied/i
+            false
+          else
+            raise LearnOpen::Adapters::SshAdapter::UnknownError
+          end
+        else
+          raise LearnOpen::Adapters::SshAdapter::UnknownError
+        end
+      end
+
+      class UnknownError < StandardError
+      end
+    end
+  end
+end

data/lib/learn_open/adapters/system_adapter.rb

@@ -1,3 +1,5 @@
+require 'open3'
+
 module LearnOpen
   module Adapters
     class SystemAdapter
@@ -22,6 +24,10 @@ module LearnOpen
         system(command)
       end
 
+      def self.run_command_with_capture(command)
+        Open3.capture3(command)
+      end
+
       def self.change_context_directory(dir)
         Dir.chdir(dir)
       end

data/lib/learn_open/environments.rb

@@ -31,5 +31,8 @@ module LearnOpen
     def self.on_linux?(platform)
       !!platform.match(/linux/)
     end
+
+    class UnknownLessonDownloadError < StandardError
+    end
   end
 end

data/lib/learn_open/environments/base_environment.rb

@@ -12,6 +12,10 @@ module LearnOpen
         @options = options
       end
 
+      def managed?
+        false
+      end
+
       def open_jupyter_lab(lesson, location, editor)
         :noop
       end
@@ -21,11 +25,17 @@ module LearnOpen
         when LearnOpen::Lessons::IosLesson
           io.puts "You need to be on a Mac to work on iOS lessons."
         else
-          download_lesson(lesson, location)
-          open_editor(lesson, location, editor)
-          install_dependencies(lesson, location)
-          notify_of_completion
-          open_shell
+          case download_lesson(lesson, location)
+          when :ok, :noop
+            open_editor(lesson, location, editor)
+            install_dependencies(lesson, location)
+            notify_of_completion
+            open_shell
+          when :ssh_unauthenticated
+            io.puts 'Failed to obtain an SSH connection!'
+          else
+            raise LearnOpen::Environments::UnknownLessonDownloadError
+          end
         end
       end
 
@@ -34,7 +44,7 @@ module LearnOpen
       end
 
       def download_lesson(lesson, location)
-        LessonDownloader.call(lesson, location, options)
+        LessonDownloader.call(lesson, location, self, options)
       end
 
       def open_editor(lesson, location, editor)
@@ -60,7 +70,7 @@ module LearnOpen
         return unless lesson.later_lesson
 
         io.puts 'WARNING: You are attempting to open a lesson that is beyond your current lesson.'
-        io.print 'Are you sure you want to continue? [Yn]: '
+        io.print 'Are you sure you want to continue? [Y/n]: '
 
         warn_response = io.gets.chomp.downcase
         exit if !['yes', 'y'].include?(warn_response)

data/lib/learn_open/environments/ide_environment.rb

@@ -1,6 +1,10 @@
 module LearnOpen
   module Environments
     class IDEEnvironment < BaseEnvironment
+      def managed?
+        true
+      end
+
       def open_readme(lesson)
         when_valid(lesson) do
           warn_if_necessary(lesson)

data/lib/learn_open/environments/jupyter_container_environment.rb

@@ -1,6 +1,10 @@
 module LearnOpen
   module Environments
     class JupyterContainerEnvironment < BaseEnvironment
+      def managed?
+        true
+      end
+
       def open_jupyter_lab(lesson, location, editor)
         download_lesson(lesson, location)
         open_editor(lesson, location, editor)

data/lib/learn_open/services/git_ssh_connector.rb

@@ -0,0 +1,40 @@
+module LearnOpen
+  class GitSSHConnector
+    attr_reader :ssh_connection, :environment
+
+    GIT_SSH_USER = 'git'
+
+    def self.call(git_server:, environment:)
+      self.new(git_server: git_server, environment: environment).call
+    end
+
+    def initialize(git_server:, environment:)
+      @ssh_connection = LearnOpen.ssh_adapter.new(user: GIT_SSH_USER, hostname: git_server)
+      @environment = environment
+    end
+
+    def call
+      if managed_environment? && ssh_unauthenticated?
+        upload_ssh_keys!
+      end
+
+      ssh_authenticated?
+    end
+
+    def upload_ssh_keys!
+      LearnOpen.learn_web_client.add_ssh_key(key: ssh_connection.public_key)
+    end
+
+    def managed_environment?
+      environment.managed?
+    end
+
+    def ssh_unauthenticated?
+      !ssh_authenticated?
+    end
+
+    def ssh_authenticated?
+      ssh_connection.authenticated?
+    end
+  end
+end

data/lib/learn_open/services/lesson_downloader.rb

@@ -1,14 +1,15 @@
 module LearnOpen
   class LessonDownloader
-    attr_reader :lesson, :location, :io, :logger, :client, :git_adapter
+    attr_reader :lesson, :location, :environment, :io, :logger, :client, :git_adapter
 
-    def self.call(lesson, location, options = {})
-      self.new(lesson, location, options).call
+    def self.call(lesson, location, environment, options = {})
+      self.new(lesson, location, environment, options).call
     end
 
-    def initialize(lesson, location, options = {})
+    def initialize(lesson, location, environment, options = {})
       @lesson = lesson
       @location = location
+      @environment = environment
       @client = options.fetch(:learn_web_client) { LearnOpen.learn_web_client }
       @logger = options.fetch(:logger) { LearnOpen.logger }
       @io = options.fetch(:io) { LearnOpen.default_io }
@@ -17,13 +18,22 @@ module LearnOpen
 
     def call
       if !repo_exists?
-        fork_repo
-        clone_repo
+        if ensure_git_ssh!
+          fork_repo
+          clone_repo
+          :ok
+        else
+          :ssh_unauthenticated
+        end
       else
         :noop
       end
     end
 
+    def ensure_git_ssh!
+      LearnOpen::GitSSHConnector.call(git_server: lesson.git_server, environment: environment)
+    end
+
     def fork_repo(retries = 3)
       logger.log('Forking repository...')
       io.puts "Forking lesson..."

data/lib/learn_open/version.rb

@@ -1,3 +1,3 @@
 module LearnOpen
-  VERSION = '1.2.21'
+  VERSION = '1.2.22'
 end

data/spec/learn_open/adapters/ssh_adapter_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe LearnOpen::Adapters::SshAdapter do
+  describe '#authenticated?' do
+    let(:status) { double() }
+    let(:ssh_adapter) { LearnOpen::Adapters::SshAdapter.new(user: 'foo', hostname: 'bar') }
+
+    it 'returns true on success' do
+      allow(status).to receive(:exitstatus).and_return(LearnOpen::Adapters::SshAdapter::SSH_AUTH_SUCCESS_EXIT_STATUS)
+      allow(LearnOpen.system_adapter).to receive(:run_command_with_capture).and_return(['', '', status])
+      expect(ssh_adapter.authenticated?).to be true
+    end
+
+    it 'return false when permission denied' do
+      allow(status).to receive(:exitstatus).and_return(LearnOpen::Adapters::SshAdapter::SSH_AUTH_FAILURE_EXIT_STATUS)
+      allow(LearnOpen.system_adapter).to receive(:run_command_with_capture).and_return(['', 'permission denied', status])
+      expect(ssh_adapter.authenticated?).to be false
+    end
+
+    it 'raises an unknown error for failures that arent permission denied' do
+      allow(status).to receive(:exitstatus).and_return(LearnOpen::Adapters::SshAdapter::SSH_AUTH_FAILURE_EXIT_STATUS)
+      allow(LearnOpen.system_adapter).to receive(:run_command_with_capture).and_return(['', 'core meltdown', status])
+      expect{ssh_adapter.authenticated?}.to raise_error LearnOpen::Adapters::SshAdapter::UnknownError
+    end
+
+    it 'raises an unknown error for other exit statuses' do
+      allow(status).to receive(:exitstatus).and_return(1337)
+      allow(LearnOpen.system_adapter).to receive(:run_command_with_capture).and_return(['', 'alien abduction', status])
+      expect{ssh_adapter.authenticated?}.to raise_error LearnOpen::Adapters::SshAdapter::UnknownError
+    end
+  end
+end

data/spec/learn_open/environments/ide_environment_spec.rb

@@ -7,6 +7,13 @@ describe LearnOpen::Environments::IDEEnvironment do
 
   let(:io) { instance_double(LearnOpen::Adapters::IOAdapter) }
 
+  before do
+    allow(LearnOpen::GitSSHConnector)
+      .to receive(:call)
+      .with(git_server: instance_of(String), environment: instance_of(LearnOpen::Environments::IDEEnvironment))
+      .and_return(true)
+  end
+
   context "Invalid environment" do
     before do
       @home_dir = create_linux_home_dir("bobby")
@@ -44,9 +51,29 @@ describe LearnOpen::Environments::IDEEnvironment do
       @home_dir = create_linux_home_dir("bobby")
     end
 
-    let(:lesson) { double(name: "valid_lab", later_lesson: false, to_url: "valid-lesson-url") }
-    let(:env_vars) {{ "LAB_NAME" => "valid_lab", "CREATED_USER" => "bobby" }}
-    let(:environment) { subject.new({ io: io, environment_vars: env_vars, logger: spy }) }
+    let(:lesson) do
+      double(
+        name: "valid_lab",
+        later_lesson: false,
+        to_url: "valid-lesson-url",
+        to_path: @home_dir,
+        git_server: "github.com",
+        repo_path: "/org/lesson"
+      )
+    end
+
+    let(:env_vars) {{ "LAB_NAME" => "valid_lab", "CREATED_USER" => "bobby", "SHELL" => "/usr/local/fish"}}
+    let(:git_adapter) { double }
+    let(:system_adapter) { double }
+    let(:environment) do
+      subject.new({
+          io: io,
+          environment_vars: env_vars,
+          logger: spy,
+          git_adapter: git_adapter,
+          system_adapter: system_adapter
+        })
+    end
 
     it "opens the readme in the browser" do
       expect(io).to receive(:puts).with("Opening readme...")
@@ -55,8 +82,33 @@ describe LearnOpen::Environments::IDEEnvironment do
       expect(custom_commands_log).to eq(%Q{{"command":"browser_open","url":"valid-lesson-url"}\n})
     end
     it "opens the lab" do
-      expect(io).to receive(:puts).with("Opening readme...")
-      environment.open_lab(lesson, double, double)
+      location = double
+      editor = "vim"
+
+      expect(io).to receive(:puts).with("Forking lesson...")
+      expect(io).to receive(:puts).with("Cloning lesson...")
+      expect(io).to receive(:puts).with("Opening lesson...")
+      expect(io).to receive(:puts).with("Done.")
+      expect(git_adapter)
+        .to receive(:clone)
+        .with("git@github.com:/org/lesson.git", "valid_lab", {:path=> location})
+      expect(system_adapter)
+        .to receive(:change_context_directory)
+        .with("/home/bobby")
+      expect(system_adapter)
+        .to receive(:open_editor)
+        .with("vim", {:path=>"."})
+      expect(system_adapter)
+        .to receive(:spawn)
+        .with("restore-lab", {:block=>true})
+      expect(system_adapter)
+        .to receive(:watch_dir)
+        .with("/home/bobby", "backup-lab")
+      expect(system_adapter)
+        .to receive(:open_login_shell)
+        .with("/usr/local/fish")
+
+      environment.open_lab(lesson, location, editor)
     end
   end
 end

data/spec/learn_open/opener_spec.rb

@@ -12,6 +12,11 @@ describe LearnOpen::Opener do
     create_home_dir
     create_netrc_file
     create_learn_config_file
+
+    allow(LearnOpen::GitSSHConnector)
+      .to receive(:call)
+      .with(git_server: instance_of(String), environment: anything)
+      .and_return(true)
   end
 
   context "Initializer" do
@@ -47,6 +52,10 @@ describe LearnOpen::Opener do
         .to receive(:fork_repo)
         .with(repo_name: "rails-dynamic-request-lab-cb-000")
 
+      expect(LearnOpen::GitSSHConnector)
+        .to receive(:call)
+        .with(git_server: instance_of(String), environment: instance_of(LearnOpen::Environments::MacEnvironment))
+
       opener = LearnOpen::Opener.new(nil, "atom", true,
                                      learn_web_client: learn_web_client,
                                      git_adapter: git_adapter,
@@ -160,7 +169,7 @@ describe LearnOpen::Opener do
 
         expect(io)
           .to receive(:print)
-          .with("Are you sure you want to continue? [Yn]: ")
+          .with("Are you sure you want to continue? [Y/n]: ")
 
         expect(io)
           .to receive(:gets)
@@ -256,6 +265,35 @@ describe LearnOpen::Opener do
   end
   context "Logging" do
     let(:environment) {{ "SHELL" => "/usr/local/bin/fish", "JUPYTER_CONTAINER" => "true" }}
+
+    it "logs if an SSH connection cannot be made" do
+      allow(LearnOpen::LessonDownloader).to receive(:call).and_return(:ssh_unauthenticated)
+
+      allow(system_adapter).to receive_messages(
+        open_editor: :noop,
+        spawn: :noop,
+        watch_dir: :noop,
+        open_login_shell: :noop,
+        change_context_directory: :noop,
+        run_command: :noop,
+      )
+
+      io = StringIO.new
+
+      opener = LearnOpen::Opener.new("ruby_lab", "atom", false,
+                                     learn_web_client: learn_web_client,
+                                     git_adapter: git_adapter,
+                                     environment_vars: environment,
+                                     system_adapter: system_adapter,
+                                     io: io)
+      opener.run
+      io.rewind
+      expect(io.read).to eq(<<-EOF)
+Looking for lesson...
+Failed to obtain an SSH connection!
+      EOF
+    end
+
     it "prints the right things" do
       allow(learn_web_client).to receive(:fork_repo)
 
@@ -743,6 +781,7 @@ Installing pip dependencies...
 Done.
 EOF
         end
+
         it "runs npm install if lab is a node lab" do
           expect(system_adapter)
             .to receive(:open_editor)

data/spec/learn_open/services/git_ssh_connector_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'pry'
+
+describe LearnOpen::GitSSHConnector do
+  let(:git_server) { 'github.example.com' }
+  let(:ssh_adapter_instance) { instance_double(LearnOpen::Adapters::SshAdapter) }
+  let(:ssh_adapter) { class_double(LearnOpen::Adapters::SshAdapter) }
+  let(:ssh_connector) { LearnOpen::GitSSHConnector.new(git_server: git_server, environment: environment) }
+  let(:environment) { instance_double(LearnOpen::Environments::IDEEnvironment) }
+
+  before do
+    allow(LearnOpen).to receive(:ssh_adapter).and_return(ssh_adapter)
+    allow(ssh_adapter).to receive(:new).with(user: 'git', hostname: git_server).and_return(ssh_adapter_instance)
+  end
+
+  context 'for an authenticated SSH connection' do
+    before do
+      allow(ssh_adapter_instance).to receive(:authenticated?).and_return(true)
+      allow(environment).to receive(:managed?).and_return(true)
+    end
+
+    it 'does not attempt to upload keys' do
+      expect(ssh_connector).to_not receive(:upload_ssh_keys!)
+      ssh_connector.call
+    end
+  end
+
+  context 'for an unauthenticated SSH connection' do
+    before do
+      allow(ssh_adapter_instance).to receive(:authenticated?).and_return(false)
+    end
+
+    context 'on a managed server' do
+      before do
+        allow(environment).to receive(:managed?).and_return(true)
+      end
+
+      it 'attempts to upload a key' do
+        expect(ssh_connector).to receive(:upload_ssh_keys!).exactly(:once)
+        ssh_connector.call
+      end
+    end
+
+    context 'on an unmanaged server' do
+      before do
+        allow(environment).to receive(:managed?).and_return(false)
+      end
+
+      it 'does not attempt to upload a key' do
+        expect(ssh_connector).to_not receive(:upload_ssh_keys!)
+        ssh_connector.call
+      end
+    end
+  end
+end

data/spec/learn_open/services/lesson_downloader_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe LearnOpen::LessonDownloader do
+  let(:lesson)   { double }
+  let(:location) { double }
+  let(:environment) { double }
+  let(:downloader) { LearnOpen::LessonDownloader.new(lesson, location, environment) }
+
+  context 'downloaded lesson' do
+    before do
+      allow(downloader).to receive(:repo_exists?).and_return(true)
+    end
+
+    context 'able to make an SSH connection' do
+      before do
+        allow(downloader).to receive(:ensure_git_ssh!).and_return(true)
+        allow(downloader).to receive(:fork_repo)
+        allow(downloader).to receive(:clone_repo)
+      end
+
+      it 'returns status :noop' do
+        expect(downloader.call).to eq :noop
+      end
+    end
+  end
+
+  context 'undownloaded lesson' do
+    before do
+      allow(downloader).to receive(:repo_exists?).and_return(false)
+    end
+
+    context 'able to make an SSH connection' do
+      before do
+        allow(downloader).to receive(:ensure_git_ssh!).and_return(true)
+        allow(downloader).to receive(:fork_repo)
+        allow(downloader).to receive(:clone_repo)
+      end
+
+      it 'forks the repo' do
+        expect(downloader).to receive(:fork_repo)
+        downloader.call
+      end
+
+      it 'clones the repo' do
+        expect(downloader).to receive(:clone_repo)
+        downloader.call
+      end
+    end
+
+    context 'unable to make an SSH connection' do
+      before do
+        allow(downloader).to receive(:ensure_git_ssh!).and_return(false)
+      end
+
+      it 'returns status :ssh_unauthenticated' do
+        expect(downloader.call).to eq :ssh_unauthenticated
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learn-open
 version: !ruby/object:Gem::Version
-  version: 1.2.21
+  version: 1.2.22
 platform: ruby
 authors:
 - Flatiron School
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.5.2
 description: 
 email:
 - learn@flatironschool.com
@@ -183,6 +183,7 @@ files:
 - lib/learn_open.rb
 - lib/learn_open/adapters/io_adapter.rb
 - lib/learn_open/adapters/learn_web_adapter.rb
+- lib/learn_open/adapters/ssh_adapter.rb
 - lib/learn_open/adapters/system_adapter.rb
 - lib/learn_open/argument_parser.rb
 - lib/learn_open/environments.rb
@@ -206,14 +207,18 @@ files:
 - lib/learn_open/services/dependency_installers/node_package_installer.rb
 - lib/learn_open/services/dependency_installers/pip_installer.rb
 - lib/learn_open/services/file_backup_starter.rb
+- lib/learn_open/services/git_ssh_connector.rb
 - lib/learn_open/services/lesson_downloader.rb
 - lib/learn_open/services/logger.rb
 - lib/learn_open/version.rb
 - spec/fakes/fake_git.rb
 - spec/fakes/fake_learn_client.rb
 - spec/fixtures/learn-config
+- spec/learn_open/adapters/ssh_adapter_spec.rb
 - spec/learn_open/environments/ide_environment_spec.rb
 - spec/learn_open/opener_spec.rb
+- spec/learn_open/services/git_ssh_connector_spec.rb
+- spec/learn_open/services/lesson_downloader_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/learn-co/learn-open
 licenses:
@@ -244,6 +249,9 @@ test_files:
 - spec/fakes/fake_git.rb
 - spec/fakes/fake_learn_client.rb
 - spec/fixtures/learn-config
+- spec/learn_open/adapters/ssh_adapter_spec.rb
 - spec/learn_open/environments/ide_environment_spec.rb
 - spec/learn_open/opener_spec.rb
+- spec/learn_open/services/git_ssh_connector_spec.rb
+- spec/learn_open/services/lesson_downloader_spec.rb
 - spec/spec_helper.rb