learn-test 3.1.2 → 3.2.0

data/lib/learn_test/strategies/mocha.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LearnTest
   module Strategies
     class Mocha < LearnTest::Strategy
@@ -8,7 +10,7 @@ module LearnTest
       end
 
       def detect
-        return false if !js_package
+        return false unless js_package
 
         (has_js_dependency?(:mocha) || in_browser?) ? true : false
       end
@@ -58,18 +60,18 @@ module LearnTest
         npm_install
 
         if in_browser?
-          exec("npm test")
+          exec('npm test')
         else
           run_node_based_mocha
         end
       end
 
       def run_node_based_mocha
-        command = if (js_package[:scripts] && js_package[:scripts][:test] || "").include?(".results.json")
-          "npm test"
+        command = if (js_package[:scripts] && js_package[:scripts][:test] || '').include?('.results.json')
+          'npm test'
         else
           install_mocha_multi
-          "node_modules/.bin/mocha -R mocha-multi --reporter-options spec=-,json=.results.json"
+          'node_modules/.bin/mocha -R mocha-multi --reporter-options spec=-,json=.results.json'
         end
 
         system(command)
@@ -84,9 +86,9 @@ module LearnTest
       end
 
       def install_mocha_multi
-        if !File.exist?('node_modules/mocha-multi')
-          run_install('npm install mocha-multi', npm_install: true)
-        end
+        return if File.exist?('node_modules/mocha-multi')
+
+        run_install('npm install mocha-multi', npm_install: true)
       end
     end
   end

data/lib/learn_test/strategies/protractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 module LearnTest
@@ -17,7 +19,7 @@ module LearnTest
       end
 
       def run
-        if !selenium_running?
+        unless selenium_running?
           stdin, stdout, stderr, wait_thr = Open3.popen3('webdriver-manager start')
           @pid = wait_thr.pid
 
@@ -88,14 +90,14 @@ module LearnTest
 
       def passing_count
         @passing_count ||= output.inject(0) do |count, test|
-          count += 1 if test[:assertions].all?{ |a| a[:passed] }
+          count += 1 if test[:assertions].all? { |a| a[:passed] }
           count
         end
       end
 
       def failure_count
         @failure_count ||= output.inject(0) do |count, test|
-          count += 1 if !test[:assertions].all? { |a| a[:passed] }
+          count += 1 unless test[:assertions].all? { |a| a[:passed] }
           count
         end
       end
@@ -114,14 +116,13 @@ module LearnTest
       end
 
       def selenium_running?
-        process = `ps aux | grep selenium`.split("\n").detect{ |p| p.include?('chromedriver') }
+        process = `ps aux | grep selenium`.split("\n").detect { |p| p.include?('chromedriver') }
         if process
           @selenium_pid = process.split[1].to_i
           return true
         end
-        return false
+        false
       end
-
     end
   end
 end

data/lib/learn_test/strategies/pytest.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'crack'
 require_relative 'pytest/requirements_checker'
 
 module LearnTest
   module Strategies
     class Pytest < LearnTest::Strategy
-
       def service_endpoint
         '/e/flatiron_pytest'
       end
@@ -22,18 +23,18 @@ module LearnTest
       end
 
       def output
-        @output ||= Crack::XML.parse(File.read('.results.xml'))["testsuite"]
+        @output ||= Crack::XML.parse(File.read('.results.xml'))['testsuite']
       end
 
       def test_files
         # pytest will run all files of the form test_*.py or *_test.py
-        @test_files ||= Dir.glob("**/test_*.py") + Dir.glob("**/*_test.py")
+        @test_files ||= Dir.glob('**/test_*.py') + Dir.glob('**/*_test.py')
       end
 
       def results
-        failed_count = output["failures"].to_i + output["errors"].to_i
-        skipped_count = output["skips"].to_i
-        passed_count = output["tests"].to_i - failed_count - skipped_count
+        failed_count = output['failures'].to_i + output['errors'].to_i
+        skipped_count = output['skips'].to_i
+        passed_count = output['tests'].to_i - failed_count - skipped_count
         {
           username: username,
           github_user_id: user_id,
@@ -43,10 +44,10 @@ module LearnTest
             test_suite: [{
               framework: 'pytest',
               formatted_output: output.to_json,
-              duration: output["time"]
+              duration: output['time']
             }]
           },
-          examples: output["tests"].to_i,
+          examples: output['tests'].to_i,
           passing_count: passed_count,
           pending_count: skipped_count,
           failure_count: failed_count,
@@ -70,16 +71,15 @@ module LearnTest
         # if there is a single test the `testcase` xml parse turns out a hash
         #   instead of an array with a single hash. this will make sure single
         #   tests have the same output structure (Array) as multiple tests
-        output["testcase"] = [output["testcase"]].flatten
+        output['testcase'] = [output['testcase']].flatten
 
-        output["testcase"].reduce([]) do |errors, example|
-          if example.has_key?("failure")
-            errors << example.map{|k, v| "#{k}: #{v}"}
+        output['testcase'].reduce([]) do |errors, example|
+          if example.has_key?('failure')
+            errors << example.map { |k, v| "#{k}: #{v}" }
           end
           errors
         end
       end
-
     end
   end
 end

data/lib/learn_test/strategies/pytest/requirements_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 module LearnTest
@@ -12,10 +14,10 @@ module LearnTest
 
     class PythonChecker
       def self.check
-        if !self.python_installed? || !self.correct_python_version?
-          puts "Please install python 2.7.x or 3.x.x"
-          exit
-        end
+        return unless !self.python_installed? || !self.correct_python_version?
+
+        puts 'Please install python 2.7.x or 3.x.x'
+        exit
       end
 
       def self.python_installed?
@@ -31,10 +33,10 @@ module LearnTest
 
     class PipChecker
       def self.check
-        if !self.pip_installed?
-          puts "Please ensure pip is installed"
-          exit
-        end
+        return if self.pip_installed?
+
+        puts 'Please ensure pip is installed'
+        exit
       end
 
       def self.pip_installed?
@@ -44,10 +46,10 @@ module LearnTest
 
     class PytestChecker
       def self.check
-        if !self.pytest_installed?
-          puts "Please ensure pytest is installed"
-          exit
-        end
+        return if self.pytest_installed?
+
+        puts 'Please ensure pytest is installed'
+        exit
       end
 
       def self.pytest_installed?

data/lib/learn_test/strategies/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LearnTest
   module Strategies
     class Rspec < LearnTest::Strategy
@@ -11,8 +13,8 @@ module LearnTest
 
       def configure
         if format_option_present?
-          if dot_rspec.any? {|dot_opt| dot_opt.match(/--format|-f/)}
-            argv << dot_rspec.reject {|dot_opt| dot_opt.match(/--format|-f/)}
+          if dot_rspec.any? { |dot_opt| dot_opt.match(/--format|-f/) }
+            argv << dot_rspec.reject { |dot_opt| dot_opt.match(/--format|-f/) }
           else
             argv << dot_rspec
           end
@@ -26,14 +28,14 @@ module LearnTest
         end
 
         if example_option_present?
-          argv << options[:example].map{|e| "--example #{e}"}.join(" ")
+          argv << options[:example].map { |e| "--example #{e}" }.join(' ')
         end
 
         # Don't pass the test/local flag from learn binary to rspec runner.
-        argv.delete("--test")
-        argv.delete("-t")
-        argv.delete("-l")
-        argv.delete("--local")
+        argv.delete('--test')
+        argv.delete('-t')
+        argv.delete('-l')
+        argv.delete('--local')
       end
 
       def run
@@ -98,13 +100,12 @@ module LearnTest
       def failures
         if output
           output[:examples].select do |example|
-            example[:status] == "failed"
-          end.map { |ex| ex[:full_description] }.join(";")
+            example[:status] == 'failed'
+          end.map { |ex| ex[:full_description] }.join(';')
         else
           'A syntax error prevented RSpec from running.'
         end
       end
-
     end
   end
 end

data/lib/learn_test/strategy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LearnTest
   class Strategy
     attr_reader :runner, :options
@@ -11,11 +13,9 @@ module LearnTest
       raise NotImplementedError, 'you must add the service endpoint to the test strategy'
     end
 
-    def check_dependencies
-    end
+    def check_dependencies; end
 
-    def configure
-    end
+    def configure; end
 
     def run
       raise NotImplementedError, 'you must implement how this strategy runs its tests'
@@ -33,8 +33,7 @@ module LearnTest
       true
     end
 
-    def cleanup
-    end
+    def cleanup; end
 
     def username
       @username ||= LearnTest::UsernameParser.get_username

data/lib/learn_test/user_id_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LearnTest
   class UserIdParser
     def self.get_user_id
@@ -6,4 +8,3 @@ module LearnTest
     end
   end
 end
-

data/lib/learn_test/username_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LearnTest
   class UsernameParser
     def self.get_username
@@ -6,7 +8,7 @@ module LearnTest
       user_id = parser.user_id
 
       if !LearnTest::LearnOauthTokenParser.get_learn_oauth_token && (!username || user_id == 'none')
-        print "Enter your github username: "
+        print 'Enter your github username: '
         username = $stdin.gets.strip
         user_id = LearnTest::GithubInteractor.get_user_id_for(username)
         parser.write(username, user_id)
@@ -16,4 +18,3 @@ module LearnTest
     end
   end
 end
-

data/lib/learn_test/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LearnTest
-  VERSION = '3.1.2'
+  VERSION = '3.2.0'
 end

data/spec/features/rspec_unit_spec.rb

@@ -1,4 +1,6 @@
-describe "Running a RSpec Unit Test" do
+# frozen_string_literal: true
+
+describe 'Running a RSpec Unit Test' 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,
@@ -30,6 +32,6 @@ describe "Running a RSpec Unit Test" do
       expect(output).to include('2 examples, 0 failures')
       expect(output).to_not include('3 examples')
       expect(output).to_not include('1 example')
-    end 
+    end
   end
 end

data/spec/fixtures/rspec-unit-spec/lib/dog.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Dog
-end
+end

data/spec/fixtures/rspec-unit-spec/spec/dog_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../lib/dog'
 
 describe Dog do
@@ -11,5 +13,5 @@ describe Dog do
 
   it 'accepts more than one example' do
     expect(subject).not_to be_an_instance_of(String)
-  end  
-end
+  end
+end

data/spec/fixtures/rspec-unit-spec/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

data/spec/learn_test/git_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+describe LearnTest::GitWip do
+  subject { described_class }
+
+  let!(:working_branch) { 'develop' }
+  let!(:git_url) { 'https://github.com/learn-co/learn-test' }
+  let!(:git_base) { instance_double(Git::Base) }
+
+  context 'success' do
+    it 'should return the git url' do
+      expect(Git::Base).to receive(:open).with('./', { log: false }).and_return(git_base)
+      expect(git_base).to receive(:current_branch).and_return(working_branch)
+
+      expect(subject).to receive(:`).with(/learn-test-wip save ".+" -u &> \/dev\/null/ )
+      expect($?).to receive(:success?).and_return(true)
+
+      expect(git_base).to receive(:push).with('origin', "wip/#{working_branch}:refs/heads/wip")
+      expect(git_base).to receive_message_chain(:config, :[]).with('remote.origin.url').and_return("#{git_url}.git")
+
+      expect(subject.run!).to eq("#{git_url}/tree/wip")
+    end
+  end
+
+  context 'failure' do
+    it 'should return false on process error' do
+      allow(Git::Base).to receive(:open).and_return(git_base)
+      allow(git_base).to receive(:current_branch)
+      allow(subject).to receive(:`)
+
+      expect($?).to receive(:success?).and_return(false)
+      expect(subject.run!).to eq(false)
+    end
+
+    it 'should return false on StandardError' do
+      expect(Git::Base).to receive(:open).and_raise(StandardError)
+      expect(subject.run!).to eq(false)
+    end
+  end
+end

data/spec/learn_test/reporter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require_relative '../../lib/learn_test/reporter'
@@ -6,14 +8,15 @@ require 'tempfile'
 require 'json'
 
 describe LearnTest::Reporter do
-  let(:strategy) {
+  let!(:client) { instance_spy(LearnTest::Client) }
+  let!(:git_tree) { 'https://github.com/learn-co/learn-test/tree/wip' }
+  let!(:strategy) do
     instance_spy(
       LearnTest::Strategy,
-      service_endpoint: "test_endpoint",
+      service_endpoint: 'test_endpoint',
       results: { test: 'result' }
     )
-  }
-  let(:client) { instance_spy(LearnTest::Client) }
+  end
 
   def with_file(name, content = nil, &block)
     file = Tempfile.new(name)
@@ -30,36 +33,62 @@ describe LearnTest::Reporter do
   describe '#report' do
     let(:reporter) { described_class.new(strategy, client: client) }
 
-    context "with debug flag and failed attempt posting results" do
-      it "outputs an error message" do
+    context 'with debug flag and failed attempt posting results' do
+      it 'outputs an error message' do
         allow(client).to receive(:post_results).and_return(false)
-        reporter.debug = true
-        io = StringIO.new
 
-        reporter.report(out: io)
+        expect do
+          reporter.debug = true
+          reporter.report
+        end.to output(/Learn/i).to_stdout
+      end
+    end
+
+    context 'sync with Github' do
+      it 'should not run LearnTest::GitWip, if :post_results fails' do
+        expect(client).to receive(:post_results).and_return(false)
+        expect(LearnTest::GitWip).to_not receive(:run!)
+
+        reporter.report
+      end
+
+      it 'should run LearnTest::GitWip.run!' do
+        expect(client).to receive(:post_results).and_return(true)
+        expect(LearnTest::GitWip).to receive(:run!).and_return(:git_tree)
+
+        reporter.report
+      end
+
+      it 'should not output an error message without debug' do
+        expect(client).to receive(:post_results).and_return(true)
+        expect(LearnTest::GitWip).to receive(:run!).and_return(false)
+
+        expect { reporter.report }.to_not output.to_stdout
+      end
+
+      it 'should output an error message with debug' do
+        expect(client).to receive(:post_results).and_return(true)
+        expect(LearnTest::GitWip).to receive(:run!).and_return(false)
 
-        expect(io.string).to_not be_empty
+        expect do
+          reporter.debug = true
+          reporter.report
+        end.to output(/Github/i).to_stdout
       end
     end
 
     it 'posts results to the service endpoint' do
       reporter.report
 
+      allow(LearnTest::GitWip).to receive(:run!).and_return(:git_tree)
+
       expect(client).to have_received(:post_results)
         .with(strategy.service_endpoint, strategy.results)
     end
 
     it 'does not output an error message without debug' do
-      allow(client).to receive(:post_results).and_return(false)
-      io = StringIO.new
-
-      with_file('test_debug') do |tmp_file|
-        reporter.output_path = tmp_file.path
-
-        reporter.report(out: io)
-
-        expect(io.string).to be_empty
-      end
+      expect(client).to receive(:post_results).and_return(false)
+      expect { reporter.report }.to_not output.to_stdout
     end
 
     it 'saves the failed attempt when the post results call fails' do
@@ -70,9 +99,9 @@ describe LearnTest::Reporter do
         reporter.report
 
         report = JSON.dump(strategy.results)
-        expect(File.exists?(tmp_file.path)).to be(true)
+        expect(File.exist?(tmp_file.path)).to be(true)
         expect(reporter.failed_reports).to eq({
-          strategy.service_endpoint => [JSON.load(report)]
+          strategy.service_endpoint => [JSON.parse(report)]
         })
       end
     end
@@ -87,8 +116,9 @@ describe LearnTest::Reporter do
         reporter.report
 
         report = JSON.dump(strategy.results)
-        json_report = JSON.load(report)
-        expect(File.exists?(tmp_file.path)).to be(true)
+        json_report = JSON.parse(report)
+
+        expect(File.exist?(tmp_file.path)).to be(true)
         expect(reporter.failed_reports).to eq({
           strategy.service_endpoint => [json_report, json_report]
         })
@@ -101,23 +131,30 @@ describe LearnTest::Reporter do
 
     it 'deletes the output file when all reports are sent successfully' do
       allow(client).to receive(:post_results).and_return(true)
-      reports = {hello: ["world"]}
+      allow(LearnTest::GitWip).to receive(:run!).and_return(:git_tree)
+
+      reports = { hello: ['world'] }
+
       with_file('retry_failed_reports', reports) do |file|
         reporter.output_path = file.path
         reporter.retry_failed_reports
 
-        expect(File.exists?(file.path)).to be(false)
+        expect(File.exist?(file.path)).to be(false)
       end
     end
 
     it 'writes the remaining reports from the output file' do
       allow(client).to receive(:post_results).and_return(true, false)
-      reports = {success: ["world"], failure: ["hello"]}
+      allow(LearnTest::GitWip).to receive(:run!).and_return(:git_tree)
+
+      reports = { success: ['world'], failure: ['hello'] }
+
       with_file('retry_failed_reports', reports) do |file|
         reporter.output_path = file.path
         reporter.retry_failed_reports
-        expect(File.exists?(file.path)).to be(true)
-        expect(reporter.failed_reports).to eq({"failure" => ["hello"]})
+
+        expect(File.exist?(file.path)).to be(true)
+        expect(reporter.failed_reports).to eq({ 'failure' => ['hello'] })
       end
     end
   end
@@ -125,6 +162,7 @@ describe LearnTest::Reporter do
   describe '#failed_reports' do
     let(:path) { 'failed_reports' }
     let(:reporter) { described_class.new(strategy, output_path: path) }
+
     subject { reporter.failed_reports }
 
     context 'with no file at location' do
@@ -137,9 +175,9 @@ describe LearnTest::Reporter do
 
     context 'with returns the JSON contents of the file' do
       it {
-        with_file(path, {hello: "world"}) do |file|
+        with_file(path, { hello: 'world' }) do |file|
           reporter.output_path = file.path
-          is_expected.to eq({"hello" => "world"})
+          is_expected.to eq({ 'hello' => 'world' })
         end
       }
     end