complete test coverage

Author: DannyBen

lib/bashly/extensions/file.rb

@@ -6,4 +6,8 @@ def self.deep_write(file, content)
     FileUtils.mkdir_p dir unless Dir.exist? dir
     File.write file, content
   end
+
+  def self.append(path, content)
+    File.open(path, "a") { |f| f << content }
+  end
 end

spec/approvals/cli/generate/dont-upgrade

@@ -0,0 +1,7 @@
+creating user files in spec/tmp/src
+skipped spec/tmp/src/initialize.sh (exists)
+skipped spec/tmp/src/download_command.sh (exists)
+skipped spec/tmp/src/upload_command.sh (exists)
+updated spec/tmp/src/lib/yaml.sh
+created spec/tmp/cli
+run spec/tmp/cli --help to test your bash script

spec/approvals/cli/generate/upgrade

@@ -0,0 +1,14 @@
+creating user files in spec/tmp/src
+skipped spec/tmp/src/initialize.sh (exists)
+skipped spec/tmp/src/download_command.sh (exists)
+skipped spec/tmp/src/upload_command.sh (exists)
+updated spec/tmp/src/lib/colors.sh
+updated spec/tmp/src/lib/config.sh
+updated spec/tmp/src/lib/send_completions.sh
+updated spec/tmp/src/lib/validations/validate_dir_exists.sh
+updated spec/tmp/src/lib/validations/validate_file_exists.sh
+updated spec/tmp/src/lib/validations/validate_integer.sh
+updated spec/tmp/src/lib/validations/validate_not_empty.sh
+updated spec/tmp/src/lib/yaml.sh
+created spec/tmp/cli
+run spec/tmp/cli --help to test your bash script

spec/approvals/cli/generate/upgrade-path-mismatch

@@ -0,0 +1,14 @@
+creating user files in spec/tmp/src
+skipped spec/tmp/src/initialize.sh (exists)
+skipped spec/tmp/src/download_command.sh (exists)
+skipped spec/tmp/src/upload_command.sh (exists)
+warning not upgrading spec/tmp/src/lib/colors-b.sh, path mismatch
+updated spec/tmp/src/lib/config.sh
+updated spec/tmp/src/lib/send_completions.sh
+updated spec/tmp/src/lib/validations/validate_dir_exists.sh
+updated spec/tmp/src/lib/validations/validate_file_exists.sh
+updated spec/tmp/src/lib/validations/validate_integer.sh
+updated spec/tmp/src/lib/validations/validate_not_empty.sh
+updated spec/tmp/src/lib/yaml.sh
+created spec/tmp/cli
+run spec/tmp/cli --help to test your bash script

spec/approvals/fixtures/lib-upgrade

@@ -0,0 +1,35 @@
++ bundle exec bashly add colors --force
+created src/lib/colors.sh
++ bundle exec bashly add yaml --force
+created src/lib/yaml.sh
++ bundle exec bashly add config --force
+created src/lib/config.sh
++ bundle exec bashly add validations --force
+created src/lib/validations/validate_dir_exists.sh
+created src/lib/validations/validate_file_exists.sh
+created src/lib/validations/validate_integer.sh
+created src/lib/validations/validate_not_empty.sh
++ bundle exec bashly add comp function --force
+created src/lib/send_completions.sh
+
+In order to enable completions in your script, create a command or a flag (for example: cli completions or cli --completions) that calls the send_completions function.
+
+Your users can then run something like this to enable completions:
+
+  $ eval "$(cli completions)"
+
++ bundle exec bashly generate --upgrade
+creating user files in src
+created src/initialize.sh
+created src/download_command.sh
+created src/upload_command.sh
+updated src/lib/colors.sh
+updated src/lib/config.sh
+updated src/lib/send_completions.sh
+updated src/lib/validations/validate_dir_exists.sh
+updated src/lib/validations/validate_file_exists.sh
+updated src/lib/validations/validate_integer.sh
+updated src/lib/validations/validate_not_empty.sh
+updated src/lib/yaml.sh
+created ./cli
+run ./cli --help to test your bash script

spec/bashly/commands/generate_spec.rb

@@ -82,5 +82,68 @@
       expect(lines[0..10].join).to match_approval('cli/generate/wrap-script')
     end
   end
+  
+  context "with --upgrade" do
+    let(:lib_files) { Dir["spec/tmp/src/lib/**/*.sh"].sort }
+    let(:outdated_text) { "OUTDATED TEXT" }
 
+    before do
+      reset_tmp_dir copy_from: 'spec/fixtures/workspaces/lib-upgrade'
+    end
+
+    it "claims to upgrade all upgradable libraries" do
+      expect { subject.run %w[generate -u] }.to output_approval('cli/generate/upgrade')
+    end
+
+    it "actually upgrades all upgradable libraries" do
+      lib_files.each do |file|
+        File.append file, outdated_text
+      end
+
+      expect { subject.run %w[generate -u] }.to output_approval('cli/generate/upgrade')
+
+      lib_files.each do |file|
+        expect(File.read file).to_not include(outdated_text),
+          "Expected to not find #{outdated_text} in #{file}, but found it"
+      end
+    end
+
+    context "when the magic comment does not exist in the target file" do
+      let(:selective_lib_files) { lib_files[0..-2] }
+
+      before do
+        selective_lib_files.each do |file|
+          File.write file, File.read(file).gsub("[@bashly-upgrade", "[@please-dont")
+        end
+      end
+
+      it "avoids upgrading it" do
+        expect { subject.run %w[generate -u] }.to output_approval('cli/generate/dont-upgrade')
+
+        selective_lib_files.each do |file|
+          expect(File.read file).to include("@please-dont"),
+            "Expected to find @please-dont in #{file}, but didn't"
+        end
+      end
+    end
+
+    context "when the upgrade candidate has a different path than the library's" do
+      let(:file) { lib_files[0] }
+      let(:custom_text) { "CUSTOM TEXT" }
+      let(:alt_filename) { file.gsub /([a-z])\.sh/, '\1-b.sh' }
+
+      before do
+        File.append file, custom_text
+        expect(system "mv #{file} #{alt_filename}").to be true
+      end
+
+      it "avoids upgrading it and shows a warning" do
+        expect { subject.run %w[generate -u] }.to output_approval('cli/generate/upgrade-path-mismatch')
+
+        expect(File.read alt_filename).to include(custom_text),
+          "Expected to find #{custom_text} in #{file}, but didn't"
+      end
+    end
+
+  end
 end

spec/bashly/integration/examples_spec.rb

@@ -10,7 +10,9 @@
   examples = Dir["examples/*"].select { |f| File.directory? f }
 
   # ...as well as internal examples, not suitable for public view
-  fixtures = Dir["spec/fixtures/workspaces/*"].select { |f| File.directory? f }
+  fixtures = Dir["spec/fixtures/workspaces/*"].select do |f|
+    File.directory? f and File.exist? "#{f}/test.sh"
+  end
 
   test_cases = fixtures + examples
 

spec/fixtures/workspaces/README.md

@@ -0,0 +1,7 @@
+These folders each contain a bashly workspace intended for testing a particular
+aspect that is not covered by other unit tests, and is not suitable for being
+a user-facing example.
+
+- Workspaces that contain a `test.sh` will be tested as part of the examples
+  test.
+- Other workspaces are used explicitely by other tests.

spec/fixtures/workspaces/lib-upgrade/.gitignore

@@ -0,0 +1 @@
+cli

spec/fixtures/workspaces/lib-upgrade/README.md

@@ -0,0 +1 @@
+This fixture workspace is used for testing `bashly g --upgrade`