learn-test 3.2.1 → 3.3.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61a75c676a837883c20d2a968fc8189019aafaa62f9b2c50fb6f9eab290b85d
-  data.tar.gz: 035da6fcfee854299e020c3a3bdfaeb6771dc14b290cd7fa29e52ac8036d508f
+  metadata.gz: 34479d2b40afafa001626db60d17a0f80273293a0d70817fc46b3c91e01f8b81
+  data.tar.gz: 6423442bb278878a96673d8769a81eaa01bbcd56b12a1080b3e696298bb06f01
 SHA512:
-  metadata.gz: 27b35edfeb3597db0d847f7395c5619f810b036bce8ab31a6855f326e1ca7793f3009700df7ecf338fd0c7bac0d363054cb8fb84d818816473b85734a19146ee
-  data.tar.gz: 7da824f00dd96bbdd50776cab9f1e4b1807dad7ec3591a4312a40ebc00dccd5f79407fcb1a8f380bafb1f0d4832e8c5d9f3f83315c539c0d473914aaa9ab4231
+  metadata.gz: eedc292d447fcc1732ae73457fae8c1c574db19ddeeea0cd1a42a527d879c4757bd951a2b47af8e1b2913714d74cf5e955ebcb0b8605eb2f4beb3b50fac5a602
+  data.tar.gz: d87fdc06850600e77021ac6891122a14a5c69bea2af562304b4d2c9e0345ea56823871f3a0b7f7e64077ee67873fc717662633562575ad6d2af734b75ca21ab1

data/.rubocop.yml

@@ -0,0 +1,27 @@
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# TODO: Add top-level module documentation
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -3,7 +3,9 @@
 source 'https://rubygems.org'
 
 group :test do
+  gem 'aruba', '~> 1.0.3'
   gem 'rspec_junit_formatter', '~> 0.4.1'
+  gem 'simplecov', require: false
 end
 
 gemspec

data/learn-test.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faraday", "~> 1.0"
   spec.add_runtime_dependency "crack", "~> 0.4.3"
   spec.add_runtime_dependency "colorize", "~> 0.8.1"
+  spec.add_runtime_dependency "zeitwerk", "~> 2.4.0"
 end

data/lib/learn_test.rb

@@ -3,41 +3,21 @@
 require 'fileutils'
 require 'oj'
 require 'colorize'
+require 'zeitwerk'
 
-require_relative 'learn_test/version'
-require_relative 'learn_test/netrc_interactor'
-require_relative 'learn_test/git_wip'
-require_relative 'learn_test/github_interactor'
-require_relative 'learn_test/user_id_parser'
-require_relative 'learn_test/username_parser'
-require_relative 'learn_test/learn_oauth_token_parser'
-require_relative 'learn_test/repo_parser'
-require_relative 'learn_test/file_finder'
-require_relative 'learn_test/runner'
-
-require_relative 'learn_test/dependency'
-
-require_relative 'learn_test/strategy'
-require_relative 'learn_test/js_strategy'
-require_relative 'learn_test/strategies/rspec'
-require_relative 'learn_test/strategies/karma'
-require_relative 'learn_test/strategies/protractor'
-require_relative 'learn_test/strategies/java_junit'
-require_relative 'learn_test/strategies/csharp_nunit'
-require_relative 'learn_test/strategies/mocha'
-require_relative 'learn_test/strategies/pytest'
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'csharp' => 'CSharp',
+  'csharp_nunit' => 'CSharpNunit'
+)
+loader.setup
 
 module LearnTest
-  module Dependencies
-    autoload :NodeJS,         'learn_test/dependencies/nodejs'
-    autoload :PhantomJS,      'learn_test/dependencies/phantomjs'
-    autoload :Karma,          'learn_test/dependencies/karma'
-    autoload :Protractor,     'learn_test/dependencies/protractor'
-    autoload :Java,           'learn_test/dependencies/java'
-    autoload :CSharp,         'learn_test/dependencies/csharp'
-    autoload :Ant,            'learn_test/dependencies/ant'
-    autoload :Imagemagick,    'learn_test/dependencies/imagemagick'
-    autoload :SeleniumServer, 'learn_test/dependencies/selenium_server'
-    autoload :Pytest,         'learn_test/dependencies/pytest'
+  def self.root
+    File.dirname __dir__
+  end
+
+  def self.bin
+    File.join root, 'bin'
   end
 end

data/lib/learn_test/git.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'git'
+
+module LearnTest
+  module Git
+    def self.open(directory: './', options: {})
+      Base.open(directory, options)
+    end
+
+    class Base < ::Git::Base
+      def wip(message:)
+        wip = Wip::Base.new(base: self, message: message)
+        wip.process!
+        wip
+      end
+    end
+  end
+end

data/lib/learn_test/git/wip/base.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'git'
+require 'logger'
+require 'tempfile'
+
+module LearnTest
+  module Git
+    module Wip
+      class Base < ::Git::Path
+        TEMPFILE = '.wip'
+        PREFIX = 'refs/wip/'
+
+        attr_reader :working_branch, :wip_branch
+
+        def initialize(base:, message:)
+          @base = base
+          @message = message
+          @success = nil
+
+          current_branch = @base.current_branch
+
+          raise NoCommitsError, 'master' if current_branch.nil? # TODO: Swap to `main`?
+
+          @tmp = Tempfile.new(TEMPFILE)
+          @working_branch = Branch.new(base: @base, name: current_branch)
+          @wip_branch = Branch.new(base: @base, name: "#{PREFIX}#{current_branch}")
+        end
+
+        def process!
+          if @wip_branch.last_revision
+            merge = @base.merge_base(@wip_branch.last_revision, @working_branch.last_revision)
+
+            @wip_branch.parent = if merge == @working_branch.last_revision
+                                   @wip_branch.last_revision
+                                 else
+                                   @working_branch.last_revision
+                                 end
+          else
+            @wip_branch.parent = @working_branch.last_revision
+          end
+
+          new_tree = build_new_tree(@wip_branch.parent)
+          @base.diff(new_tree, @wip_branch.parent)
+
+          # tree_diff = @base.diff(new_tree, @wip_branch.parent)
+          # raise LearnTest::Git::Wip::NoChangesError, @wip_branch if tree_diff.count.zero?
+
+          commit = @base.commit_tree(new_tree, parent: @wip_branch.parent)
+
+          @base.lib.send(:command, 'update-ref', ['-m', @message, @wip_branch, commit.objectish])
+
+          @success = true
+        ensure
+          cleanup
+        end
+
+        def success?
+          @success
+        end
+
+        private
+
+        def build_new_tree(wip_parent)
+          index = "#{@tmp.path}-index"
+
+          FileUtils.rm(index, force: true)
+          FileUtils.cp("#{@base.dir.path}/.git/index", index)
+
+          @base.read_tree(wip_parent)
+          @base.lib.send(:command, 'add', ['--update', '--', '.'])
+          @base.add(all: true)
+
+          new_tree_obj = @base.write_tree
+
+          FileUtils.rm(index, force: true)
+
+          new_tree_obj
+        end
+
+        def cleanup
+          FileUtils.rm("#{@tmp.path}-*", force: true)
+        end
+      end
+    end
+  end
+end

data/lib/learn_test/git/wip/branch.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module LearnTest
+  module Git
+    module Wip
+      class Branch
+        attr_accessor :parent
+
+        def initialize(base:, name:)
+          @base = base
+          @name = name
+        end
+
+        def last_revision(raise_no_commits: false)
+          @last_revision ||= begin
+            begin
+              @base.revparse(@name)
+            rescue ::Git::GitExecuteError => e
+              if raise_no_commits
+                raise e.message.match(LearnTest::Git::Wip::NoCommitsError::REGEX) ? LearnTest::Git::Wip::NoCommitsError.new(@name) : e
+              end
+
+              raise unless e.message.match(LearnTest::Git::Wip::NoCommitsError::REGEX)
+
+              false
+            end
+          end
+        end
+
+        def to_s
+          @name
+        end
+      end
+    end
+  end
+end

data/lib/learn_test/git/wip/error.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module LearnTest
+  module Git
+    module Wip
+      class Error < StandardError; end
+
+      class NoChangesError < Error
+        def initialize(branch)
+          super "No changes found on `#{branch}`"
+        end
+      end
+
+      class NoCommitsError < Error
+        REGEX = /unknown revision or path not in the working tree/i.freeze
+
+        def initialize(branch)
+          super "Branch `#{branch}` doesn't have any commits. Please commit and try again."
+        end
+      end
+    end
+  end
+end

data/lib/learn_test/repo_parser.rb

@@ -6,7 +6,7 @@ module LearnTest
   class RepoParser
     def self.get_repo
       begin
-        repo = Git.open(FileUtils.pwd)
+        repo = ::Git.open(FileUtils.pwd)
       rescue
         puts "You don't appear to be in a Learn lesson's directory. Please enter 'learn open' or cd to an appropriate directory and try again."
         die

data/lib/learn_test/reporter.rb

@@ -3,9 +3,6 @@
 require 'fileutils'
 require 'json'
 
-require_relative 'client'
-require_relative 'git_wip'
-
 module LearnTest
   class Reporter
     attr_accessor :output_path, :debug
@@ -50,16 +47,30 @@ module LearnTest
       endpoint = strategy.service_endpoint
       augment_results!(results)
 
-      if client.post_results(endpoint, results)
-        if !LearnTest::GitWip.run! && @debug
-          puts 'There was a problem connecting to Github. Not pushing current branch state.'.red
-        end
-      else
-        if @debug
-          puts 'There was a problem connecting to Learn. Not pushing test results.'.red
-        end
+      unless client.post_results(endpoint, results)
+        puts 'There was a problem connecting to Learn. Not pushing test results.'.red if @debug
 
         save_failed_attempt(endpoint, results)
+        return
+      end
+
+      logger = @debug ? Logger.new(STDOUT, level: Logger::DEBUG) : false
+      repo = LearnTest::Git.open(options: { log: logger })
+
+      res = repo.wip(message: 'Automatic test submission')
+
+      unless res.success?
+        puts 'There was a problem creating your WIP branch. Not pushing current branch state.'.red if @debug
+        return
+      end
+
+      begin
+        repo.push('origin', "#{res.wip_branch}:refs/heads/fis-wip", { force: true })
+      rescue ::Git::GitExecuteError => e
+        if @debug
+          puts 'There was a problem connecting to Github. Not pushing current branch state.'.red
+          puts e.message
+        end
       end
     end
 
@@ -89,7 +100,7 @@ module LearnTest
 
     def augment_results!(results)
       if File.exist?("#{FileUtils.pwd}/.learn")
-        dot_learn = YAML.load(File.read("#{FileUtils.pwd}/.learn"))
+        dot_learn = YAML.safe_load(File.read("#{FileUtils.pwd}/.learn"))
 
         unless dot_learn['github'].nil?
           results[:github] = dot_learn['github']

data/lib/learn_test/runner.rb

@@ -9,7 +9,6 @@ module LearnTest
     def initialize(repo, options = {})
       @repo = repo
       @options = options
-      die unless strategy
     end
 
     def run
@@ -34,7 +33,11 @@ module LearnTest
     end
 
     def strategy
-      @strategy ||= strategies.map { |s| s.new(self) }.detect(&:detect)
+      return @strategy if @strategy
+
+      detected = strategies.map { |s| s.new(self) }.detect(&:detect)
+
+      @strategy = detected || LearnTest::Strategies::None.new(self)
     end
 
     private
@@ -68,10 +71,5 @@ module LearnTest
     def local_test_run?
       options.include?('-h') || options.include?('--local')
     end
-
-    def die
-      puts "This directory doesn't appear to have any specs in it."
-      exit
-    end
   end
 end

data/lib/learn_test/strategies/none.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module LearnTest
+  module Strategies
+    class None < LearnTest::Strategy
+      def service_endpoint
+        '/e/flatiron_none'
+      end
+
+      def run
+        puts <<~MSG
+          This directory doesn't appear to have any specs in it, so there’s no test to run.
+
+          If you are working on Canvas, this assignment has been submitted. You can resubmit by running `learn test` again.
+        MSG
+      end
+
+      def results
+        {
+          username: username,
+          github_user_id: user_id,
+          learn_oauth_token: learn_oauth_token,
+          repo_name: runner.repo,
+          build: {
+            test_suite: [{ framework: 'none' }]
+          },
+          examples: 0,
+          passing_count: 0,
+          pending_count: 0,
+          failure_count: 0,
+          failure_descriptions: ''
+        }
+      end
+    end
+  end
+end

data/lib/learn_test/strategy.rb

@@ -63,7 +63,7 @@ module LearnTest
       if npm_install
         system(command)
       else
-        Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+        Open3.popen3(command) do |_, stdout, stderr, wait_thr|
           while out = stdout.gets do
             puts out
           end

data/lib/learn_test/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LearnTest
-  VERSION = '3.2.1'
+  VERSION = '3.3.0.pre.2'
 end

data/spec/features/rspec_unit_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-describe 'Running a RSpec Unit Test' do
-  before(:all) do
+describe 'Running a RSpec Unit Test', type: :aruba do
+  before :all do
     # While it doesn't cause these tests to fail, nasty messages occur (and more)
     # when either a ~/.netrc entry or file itself doesn't exist. This aims to correct that,
     # and will only ever be called once.
@@ -9,9 +9,23 @@ describe 'Running a RSpec Unit Test' do
     LearnTest::UsernameParser.get_username
   end
 
+  before :each do
+    copy '%/rspec-unit-spec', 'example'
+    cd 'example'
+
+    git_init
+    git_add
+    git_commit 'Initial Commit'
+  end
+
+  def run(flags = '')
+    run_command_and_stop("#{File.join(LearnTest.bin, 'learn-test')} #{flags}")
+    last_command_started.output
+  end
+
   context 'a basic rspec unit test' do
     it 'runs the spec with 0 failures' do
-      output = `cd ./spec/fixtures/rspec-unit-spec && ./../../../bin/learn-test --local --test`
+      output = run('--local --test')
 
       expect(output).to include('3 examples, 0 failures')
       expect(output).to_not include('1 failures')
@@ -20,14 +34,14 @@ describe 'Running a RSpec Unit Test' do
 
   context 'with the --example flag' do
     it 'runs only the appropriate tests' do
-      output = `cd ./spec/fixtures/rspec-unit-spec && ./../../../bin/learn-test --local --test --example multiple`
+      output = run('--local --test --example multiple')
 
       expect(output).to include('1 example, 0 failures')
       expect(output).to_not include('2 examples')
     end
 
-     it 'accepts multiple examples' do
-      output = `cd ./spec/fixtures/rspec-unit-spec && ./../../../bin/learn-test --local --test --example multiple --example accepts`
+    it 'accepts multiple examples' do
+      output = run(' --local --test --example multiple --example accepts')
 
       expect(output).to include('2 examples, 0 failures')
       expect(output).to_not include('3 examples')