Do not change or generate README.md after running rspec #8629

nafu · 2017-03-23T18:42:46Z

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I've read the Contribution Guidelines
I've updated the documentation if necessary.

Description

Do not change or generate README.md after running rspec.
If anybody knows better way for handling this, please feedback to this PR. 🙏

Motivation and Context

After running rspec, it generates some README.md on my machine that is not needed without this patch.

KrauseFx

I noticed those files too, and thought it's related to my machine somehow. Instead of adding those workarounds, can we just not generate those files at all instead? Maybe just mock the method that writes out the file?

KrauseFx · 2017-03-24T00:12:08Z

fastlane/spec/cli_tools_distributor_spec.rb

@@ -50,6 +50,8 @@
      expect do
        Fastlane::CLIToolsDistributor.take_off
      end.to raise_error(SystemExit)
+
+      `git checkout fastlane/README.md`


That seems like a hack, can we just not generate the file in the first place instead?

KrauseFx · 2017-03-24T00:12:12Z

fastlane/spec/commands_generator_spec.rb

    allow(FastlaneCore::FastlaneFolder).to receive(:path).and_return(fastlane_folder)
  end

+  after(:all) do
+    FileUtils.rm(File.join(fastlane_folder, 'README.md'))


KrauseFx · 2017-03-24T00:12:15Z

fastlane/spec/lane_manager_spec.rb

@@ -70,7 +72,11 @@ def ensure_dot_env_value_from_folders(folders, envs, expected_values)

      describe "successfull init" do
        before do
-          allow(FastlaneCore::FastlaneFolder).to receive(:path).and_return(File.absolute_path('./fastlane/spec/fixtures/fastfiles/'))
+          allow(FastlaneCore::FastlaneFolder).to receive(:path).and_return(fastlane_folder)


KrauseFx · 2017-03-24T00:59:10Z

fastlane/spec/commands_generator_spec.rb

@@ -5,6 +5,8 @@
    ENV['DOTENV'] = nil
    fastlane_folder = File.absolute_path('./fastlane/spec/fixtures/dotenvs/withFastfiles/parentonly/fastlane')
    allow(FastlaneCore::FastlaneFolder).to receive(:path).and_return(fastlane_folder)
+    allow(FastlaneCore::Env).to receive(:truthy?).and_return(:default)
+    allow(FastlaneCore::Env).to receive(:truthy?).with('FASTLANE_SKIP_DOCS').and_return(true)


Should we set this for all tests inside the spec_helper?

@KrauseFx Uhh, no after all. I tried to define these in spec_helper, and it had other problems to cause test failure.

nafu · 2017-03-24T00:59:39Z

fastlane/spec/cli_tools_distributor_spec.rb

@@ -43,6 +43,8 @@
    end

    it "checks for updates even if the lane has an error" do
+      allow(FastlaneCore::Env).to receive(:truthy?).and_return(:default)
+      allow(FastlaneCore::Env).to receive(:truthy?).with('FASTLANE_SKIP_DOCS').and_return(true)


There is 3 duplication codes, so it is better to define helper in fastlane_core/spec/spec_helper.rb or fastlane/spec/spec_helper.rb?

giginet

I think this solution is strange.

You should not stub this environment variables.

It's natural to skip executing DocsGenerator.run in testing.

fastlane/fastlane/lib/fastlane/lane_manager.rb

Line 64 in 60bac7e

    
           Fastlane::DocsGenerator.run(ff) unless FastlaneCore::Env.truthy?("FASTLANE_SKIP_DOCS")

Fastlane::DocsGenerator.run(ff) if !Helper.test? && !FastlaneCore::Env.truthy?("FASTLANE_SKIP_DOCS")

nafu · 2017-03-28T13:03:24Z

Hmm, CircleCI select Xcode 7.0 😓

https://circleci.com/gh/fastlane/fastlane/8447

nafu · 2017-03-29T00:43:25Z

@KrauseFx @giginet
I addressed the feedbacks, could you review again?

KrauseFx

Looks great 👍 Thanks @nafu

giginet · 2017-03-30T17:41:33Z

@nafu Sorry for my late reply.
You can merge it 😄

nafu · 2017-04-01T05:44:08Z

@KrauseFx @giginet Thanks 🚀

fastlane-bot · 2017-04-01T13:00:55Z

Hey @nafu 👋

Thank you for your contribution to fastlane and congrats on getting this pull request merged 🎉
The code change now lives in the master branch, however it wasn't released to RubyGems yet.
We usually ship about once a week, and your PR will be included in the next one.

Please let us know if this change requires an immediate release by adding a comment here 👍
We'll notify you once we shipped a new release with your changes 🚀

fastlane-bot · 2017-04-07T13:02:56Z

Congratulations! 🎉 This was released as part of fastlane 2.25.0 🚀

Do not change or generate README.md after running rspec

4d19fdd

googlebot added the cla: yes label Mar 23, 2017

KrauseFx requested changes Mar 24, 2017

View reviewed changes

nafu added 2 commits March 24, 2017 09:53

Mock FastlaneCore::Env to skip generating docs

126cb53

Do not change existing code in lane_manager_spec

edf4a84

KrauseFx reviewed Mar 24, 2017

View reviewed changes

nafu commented Mar 24, 2017

View reviewed changes

giginet requested changes Mar 26, 2017

View reviewed changes

nafu added 3 commits March 28, 2017 21:16

Feedback addressed

8f0f698

Fix rubocop error by extracting method

07be685

Merge branch 'master' into remove-readme-after-run-rspec

4bc418c

KrauseFx approved these changes Mar 29, 2017

View reviewed changes

giginet approved these changes Mar 30, 2017

View reviewed changes

nafu merged commit 068aecb into fastlane:master Apr 1, 2017

nafu deleted the remove-readme-after-run-rspec branch April 1, 2017 05:44

fastlane-bot added the status: included-in-next-release label Apr 1, 2017

KrauseFx mentioned this pull request Apr 3, 2017

Version bump to 2.25.0 #8758

Merged

fastlane-bot added status: released and removed status: included-in-next-release labels Apr 7, 2017

cvermilion mentioned this pull request Apr 25, 2017

pilot fails to add internal tester due to no "default external group" #8999

Closed

2 tasks

fastlane locked and limited conversation to collaborators Jul 6, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not change or generate README.md after running rspec #8629

Do not change or generate README.md after running rspec #8629

nafu commented Mar 23, 2017

KrauseFx left a comment

KrauseFx Mar 24, 2017

KrauseFx Mar 24, 2017

KrauseFx Mar 24, 2017

KrauseFx Mar 24, 2017

nafu Mar 24, 2017

nafu Mar 24, 2017

nafu Mar 24, 2017

giginet left a comment

nafu commented Mar 28, 2017

nafu commented Mar 29, 2017

KrauseFx left a comment

giginet commented Mar 30, 2017

nafu commented Apr 1, 2017

fastlane-bot commented Apr 1, 2017

fastlane-bot commented Apr 7, 2017

Do not change or generate README.md after running rspec #8629

Do not change or generate README.md after running rspec #8629

Conversation

nafu commented Mar 23, 2017

Checklist

Description

Motivation and Context

KrauseFx left a comment

Choose a reason for hiding this comment

KrauseFx Mar 24, 2017

Choose a reason for hiding this comment

KrauseFx Mar 24, 2017

Choose a reason for hiding this comment

KrauseFx Mar 24, 2017

Choose a reason for hiding this comment

KrauseFx Mar 24, 2017

Choose a reason for hiding this comment

nafu Mar 24, 2017

Choose a reason for hiding this comment

nafu Mar 24, 2017

Choose a reason for hiding this comment

nafu Mar 24, 2017

Choose a reason for hiding this comment

giginet left a comment

Choose a reason for hiding this comment

nafu commented Mar 28, 2017

nafu commented Mar 29, 2017

KrauseFx left a comment

Choose a reason for hiding this comment

giginet commented Mar 30, 2017

nafu commented Apr 1, 2017

fastlane-bot commented Apr 1, 2017

fastlane-bot commented Apr 7, 2017