gemfile-audit 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7075c7b895832615c7a6f71f7e9dcaeb697b6c077a4d1ba6cd6a453c9168f9b
-  data.tar.gz: 5bb001386eb6f57b5101d2794a675449d17295bdce54a1c81287008b0cba8075
+  metadata.gz: df17a16b96f971f02e069cebfb9ea8fe2112256ab8fecb0000907eb7e11db7cd
+  data.tar.gz: f9278dc5f11d9bec700f87909145c9a6b7a861d7dc72537893c97ed1658dc82f
 SHA512:
-  metadata.gz: fd5c6848b704868311ff14a0d6c9db8d625784f2755d7035c35f47dd96c624efaec585d05eda4ad5f16b81e05c2e0259954973ee54030ff3b85398a7b2eea331
-  data.tar.gz: 5c1f1be103e1dc761dd7eefd9b0fb01eab94a936582cf97f211fca242a2d1e4fe9f99de1c4dd3eb951519dae17672d29a991e371ad87f0b63550a5009e314381
+  metadata.gz: 2f715ac5c44fbbe37ee25321c4ba45463596a52754ef1ba11bdd6a6cfe9975516b5aad3d4653bccc261e0aeb4d75b46503a555ee22792907b0da3d7c5ad15ce9
+  data.tar.gz: 221ab17fb04dece85213a296bfbc06a2c6dbaf4439e4e1a0c52b1dfc01b9e97657e8e82849d1e3309c494836ac59a90487dfc5710a5bbc9d7319a68b07eb15a4

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 1.1.0
+
+gemfile-audit run finds your tests itself (RSpec, Minitest, Cucumber) and warns when no tests ran.
+
+## 1.0.0
+
+First release.

data/README.md

@@ -21,6 +21,24 @@ gemfile-audit measures your Rails test run while it happens: how much of your co
 - secrets;
 - database contents.
 
+## Quick start
+
+```sh
+gemfile-audit run
+```
+
+`gemfile-audit run` finds your tests itself. It looks for RSpec, Minitest and Cucumber in the current folder, runs each one it finds and uploads one measurement at the end. If you run your tests another way, give the command yourself:
+
+```sh
+gemfile-audit run -- <command>
+```
+
+When it finds more than one suite, it runs each in turn, in the order RSpec, Minitest, Cucumber, inside one measured run. The exit status is the first failing status. If a command is stopped by a signal or cannot be started, that status is used instead, the remaining suites are not run and nothing is uploaded.
+
+If it cannot find any tests it says so and exits with status 2, so a build never passes without running tests. If a run finishes with no tests counted, it prints "no tests ran" and, when it found a different command, suggests it.
+
+In CI, use the explicit form shown in the examples below.
+
 ## GitHub Actions
 
 Add these steps to your workflow. They must come after the step that installs Ruby:
@@ -37,6 +55,8 @@ Add these steps to your workflow. They must come after the step that installs Ru
 
 The extra steps never fail your build.
 
+The CI examples below use `gemfile-audit run -- bundle exec rspec`. If the gem is missing, they run the same command directly, so your tests still run. Use your project's own test command in both places.
+
 ## GitLab
 
 Put these lines after Ruby is available in the job:
@@ -84,7 +104,7 @@ Merge request and pull request pipelines are not uploaded. A run there prints "n
 
 ```sh
 gem install gemfile-audit
-gemfile-audit run -- bundle exec rspec
+gemfile-audit run
 ```
 
 Run it from your app folder. The preview is labelled as a local run.
@@ -94,14 +114,14 @@ Run it from your app folder. The preview is labelled as a local run.
 Add `--dry-run` to print the upload instead of sending it:
 
 ```sh
-gemfile-audit run --dry-run -- bundle exec rspec
+gemfile-audit run --dry-run
 ```
 
 ## Requirements
 
 - Ruby 2.3 or newer.
 - Rails 4.2 or newer.
-- Tests that run with one command.
+- RSpec, Minitest or Cucumber tests, or one command that runs them.
 
 ## Privacy
 

data/lib/gemfile_audit/cli.rb

@@ -18,7 +18,8 @@ module GemfileAudit
       Usage:
         gemfile-audit start                          Prepare the environment. In a shell, run: eval "$(gemfile-audit start)"
         gemfile-audit finish [--dry-run]             Collect the run and upload it
-        gemfile-audit run [--dry-run] -- <command>   Run a command, measure it and upload the run
+        gemfile-audit run [--dry-run]                Find your tests (RSpec, Minitest, Cucumber), run, measure and upload
+        gemfile-audit run [--dry-run] -- <command>   Run your own test command instead
         gemfile-audit --version                      Print the version
         gemfile-audit help                           Print this text
 
@@ -138,7 +139,7 @@ module GemfileAudit
       nil
     end
 
-    def finish_run(env, dry_run)
+    def finish_run(env, dry_run, hint: nil)
       dir = env["GEMFILE_AUDIT_DIR"].to_s
       root = env["GEMFILE_AUDIT_ROOT"].to_s
       if dir.empty? || root.empty?
@@ -156,6 +157,8 @@ module GemfileAudit
         return 0
       end
       upload = Collector.new(dir: dir, root: root, ci: ci, env: env).upload
+      hint_line = hint && hint.call(upload["tests"])
+      @err.puts(hint_line) if hint_line
       if dry_run
         @out.puts(JSON.pretty_generate(upload))
         return 0
@@ -214,22 +217,64 @@ module GemfileAudit
 
     def run(args)
       options, command = split_run(args)
-      return usage_error("run needs a command, for example: gemfile-audit run -- bundle exec rspec") if command.empty?
       dry_run = options.include?("--dry-run")
       ignore_unknown(options - ["--dry-run"])
 
+      explicit = !command.empty?
+      detected = Detector.new(root: @dir, env: @env).commands
+      if explicit
+        commands = [command]
+      else
+        if detected.empty?
+          @err.puts("gemfile-audit: could not find your tests. Run them through gemfile-audit run -- <your test command>.")
+          return 2
+        end
+        commands = detected.map { |text| Shellwords.split(text) }
+        detected.each { |text| @err.puts("gemfile-audit: would run #{text}") } if dry_run
+      end
+
       environment = begin
         @env.merge(audit_environment)
       rescue StandardError, ScriptError => error
         warn_line("could not prepare the run: #{sentence(error.message)} Your build is not affected.")
         nil
       end
-      status, measured = execute(environment || @env, command)
-      finish_run(environment, dry_run) if environment && measured
+      status = 0
+      measured = false
+      stopped = false
+      commands.each do |each_command|
+        @err.puts("gemfile-audit: running #{each_command.join(' ')}") unless explicit
+        code, ran = execute(environment || @env, each_command)
+        # A signal or a missing command stops the run, so it wins over an
+        # earlier ordinary failure.
+        status = code if (status == 0 || !ran) && code != 0
+        measured ||= ran
+        # A signal or a command that cannot start ends the run: no more
+        # commands and no upload.
+        next if ran
+        stopped = true
+        break
+      end
+      measured = false if stopped
+      hint = no_tests_hint(explicit ? command.join(" ") : nil, detected)
+      finish_run(environment, dry_run, hint: hint) if environment && measured
       clear(environment["GEMFILE_AUDIT_DIR"]) if environment && !measured
       status
     end
 
+    # A hint for after the run. It never changes the upload or the status.
+    def no_tests_hint(given, detected)
+      lambda do |tests|
+        next nil unless (tests && tests["run"] == 0) || (tests.nil? && given)
+        suggestion = detected.reject { |text| text.split(" ").first(2) == given.to_s.split(" ").first(2) }
+        if given && !suggestion.empty?
+          "gemfile-audit: no tests ran. Did you mean #{suggestion.join(' and ')}?"
+        else
+          "gemfile-audit: no tests ran."
+        end
+      end
+    end
+
     # Everything after -- is the command. Without --, the command starts at
     # the first argument that is not an option.
     def split_run(args)

data/lib/gemfile_audit/collector.rb

@@ -43,14 +43,20 @@ module GemfileAudit
       }
     end
 
+    # The Gemfile.lock next to BUNDLE_GEMFILE, else the one in the root.
+    def self.lockfile_path(root, env)
+      root = File.expand_path(root.to_s)
+      candidates = []
+      gemfile = env["BUNDLE_GEMFILE"]
+      candidates << File.join(File.dirname(File.expand_path(gemfile, root)), "Gemfile.lock") if gemfile && !gemfile.empty?
+      candidates << File.join(root, "Gemfile.lock")
+      candidates.find { |candidate| File.file?(candidate) }
+    end
+
     private
 
     def read_lockfile
-      candidates = []
-      gemfile = @env["BUNDLE_GEMFILE"]
-      candidates << File.join(File.dirname(File.expand_path(gemfile, @root)), "Gemfile.lock") if gemfile && !gemfile.empty?
-      candidates << File.join(@root, "Gemfile.lock")
-      path = candidates.find { |candidate| File.file?(candidate) }
+      path = self.class.lockfile_path(@root, @env)
       raise Missing, "No Gemfile.lock found in #{@root}." unless path
       text = File.read(path, mode: "rb").force_encoding(Encoding::UTF_8)
       text = text.scrub("?") unless text.valid_encoding?

data/lib/gemfile_audit/detector.rb

@@ -0,0 +1,61 @@
+module GemfileAudit
+  # Finds the test commands of a project from its lockfile and folders. It
+  # only looks at file names and never fails: anything unreadable counts as
+  # not found.
+  class Detector
+    def initialize(root:, env: ENV)
+      @root = File.expand_path(root.to_s)
+      @env = env
+    end
+
+    def commands
+      found = []
+      found << "bundle exec rspec" if rspec?
+      found << minitest_command if minitest?
+      found << "bundle exec cucumber" if cucumber?
+      found
+    rescue StandardError
+      []
+    end
+
+    private
+
+    def rspec?
+      locked?("rspec-core") && File.directory?(File.join(@root, "spec"))
+    end
+
+    def cucumber?
+      locked?("cucumber") && File.directory?(File.join(@root, "features"))
+    end
+
+    # A test helper is enough. Otherwise a test file counts when it is not a
+    # system test, a fixture or inside node_modules, and Minitest is locked.
+    def minitest?
+      return true if File.file?(File.join(@root, "test", "test_helper.rb"))
+      return false unless locked?("minitest") || locked?("railties")
+      Dir.glob(File.join(@root, "test", "**", "*_test.rb")).any? do |path|
+        relative = path[(@root.size + 1)..-1]
+        !relative.start_with?("test/fixtures/", "test/system/") && !relative.split("/").include?("node_modules")
+      end
+    end
+
+    def minitest_command
+      rails = File.file?(File.join(@root, "bin", "rails")) && locked?("railties")
+      rails ? "bin/rails test" : "bundle exec rake test"
+    end
+
+    def locked?(name)
+      !(lockfile =~ /^ {4}#{Regexp.escape(name)} \(/).nil?
+    end
+
+    def lockfile
+      @lockfile ||= begin
+        path = Collector.lockfile_path(@root, @env)
+        text = path ? File.read(path, mode: "rb").force_encoding(Encoding::UTF_8) : ""
+        text.valid_encoding? ? text : text.scrub("?")
+      rescue StandardError
+        ""
+      end
+    end
+  end
+end

data/lib/gemfile_audit/version.rb

@@ -1,3 +1,3 @@
 module GemfileAudit
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/gemfile_audit.rb

@@ -2,6 +2,7 @@ require "gemfile_audit/version"
 require "gemfile_audit/shell"
 require "gemfile_audit/ci"
 require "gemfile_audit/collector"
+require "gemfile_audit/detector"
 require "gemfile_audit/uploader"
 require "gemfile_audit/cli"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemfile-audit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Despo Pentara
@@ -60,6 +60,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - exe/gemfile-audit
@@ -67,6 +68,7 @@ files:
 - lib/gemfile_audit/ci.rb
 - lib/gemfile_audit/cli.rb
 - lib/gemfile_audit/collector.rb
+- lib/gemfile_audit/detector.rb
 - lib/gemfile_audit/loader.rb
 - lib/gemfile_audit/measurement.rb
 - lib/gemfile_audit/shell.rb