init.rb in danger-0.5.0

- old
+ new
@@ -1,25 +1,269 @@
+require 'danger/commands/init_helpers/interviewer'
+require 'danger/ci_source/local_git_repo'
+require 'yaml'
+
 module Danger
   class Init < Runner
-    self.description = 'Creates a Dangerfile.'
+    self.summary = 'Helps you set up Danger.'
     self.command = 'init'
 
+    def self.options
+      [
+        ['--impatient', "'I've not got all day here. Don't add any thematic delays please.'"],
+        ['--mousey', "'Don't make me press return to continue the adventure.'"]
+      ].concat(super)
+    end
+
     def initialize(argv)
-      @dangerfile_path = "Dangerfile" if File.exist? "Dangerfile"
+      ui.no_delay = argv.flag?('impatient', false)
+      ui.no_waiting = argv.flag?('mousey', false)
+      @bot_name = File.basename(Dir.getwd).split(".").first.capitalize + "Bot"
       super
     end
 
-    def validate!
-      if @dangerfile_path
-        help! "Found an existing Dangerfile."
-      end
+    def run
+      ui = Interviewer.new
+      ui.say "\nOK, thanks #{ENV['LOGNAME']}, grab a seat and we'll get you started.\n".yellow
+      ui.pause 1
+
+      show_todo_state
+      ui.pause 1.4
+
+      setup_dangerfile
+      setup_github_account
+      setup_access_token
+      setup_danger_ci
+
+      info
+      thanks
     end
 
-    def run
-      dir = Danger.gem_path
+    def ui
+      @ui ||= Interviewer.new
+    end
 
+    def show_todo_state
+      ui.say "We need to do the following steps:\n"
+      ui.pause 0.6
+      ui.say " - [ ] Create a Dangerfile and add a few simple rules."
+      ui.pause 0.6
+      ui.say " - [#{@account_created ? 'x' : ' '}] Create a GitHub account for Danger use for messaging."
+      ui.pause 0.6
+      ui.say " - [ ] Set up an access token for Danger."
+      ui.pause 0.6
+      ui.say " - [ ] Set up Danger to run on your CI.\n\n"
+    end
+
+    def setup_dangerfile
+      dir = Danger.gem_path
       content = File.read(File.join(dir, "lib", "assets", "DangerfileTemplate"))
       File.write("Dangerfile", content)
-      puts "Successfully created 'Dangerfile'"
+
+      ui.header 'Step 1: Creating a starter Dangerfile'
+      ui.say "I've set up an example Dangerfile for you in this folder.\n"
+      ui.pause 1
+
+      ui.say "cat #{Dir.pwd}/Dangerfile\n".blue
+      content.lines.each do |l|
+        ui.say "  " + l.chomp.green
+      end
+      ui.say ""
+      ui.pause 2
+
+      ui.say "There's a collection of small, simple ideas in here, but Danger is about being able to easily"
+      ui.say "iterate. The power comes from you have the ability to codify fixes to some of the problems"
+      ui.say "that come up in day to day programming. It can be difficult to try and see those from day 1."
+
+      ui.say "\nIf you'd like to investigate the file, and make some changes - I'll wait here,"
+      ui.say "press return when you're ready to move on…"
+      ui.wait_for_return
+    end
+
+    def setup_github_account
+      ui.header 'Step 2: Creating a GitHub account'
+
+      ui.say "In order to get the most out of Danger, I'd recommend given her the ability to post in"
+      ui.say "the code-review comment section.\n\n"
+      ui.pause 1
+
+      ui.say "IMO, it's best do this by using the private mode of your browser. Create an account like"
+      ui.say "#{@bot_name}, and don't forget a cool robot avatar.\n\n"
+      ui.pause 1
+      ui.say 'Here are great resources for creative commons images of robots:'
+      ui.link 'https://www.flickr.com/search/?text=robot&license=2%2C3%2C4%2C5%2C6%2C9'
+      ui.link 'https://www.google.com/search?q=robot&tbs=sur:fmc&tbm=isch&tbo=u&source=univ&sa=X&ved=0ahUKEwjgy8-f95jLAhWI7hoKHV_UD00QsAQIMQ&biw=1265&bih=1359'
+
+      ui.say ""
+      note_about_clicking_links
+      ui.pause 1
+      ui.say "\nCool, please press return when you have your account ready (and you've verified the email…)"
+      ui.wait_for_return
+    end
+
+    def setup_access_token
+      ui.header 'Step 3: Configuring a GitHub Personal Access Token'
+
+      ui.say "Here's the link, you should open this in your private session with the new GitHub account"
+      ui.link "https://github.com/settings/tokens/new"
+      ui.pause 1
+
+      @is_open_source = ui.ask_with_answers("For token access rights, I need to know if this is for an Open Source or Closed Source project\n", ["Open", "Closed"])
+
+      if considered_an_oss_repo?
+        ui.say "For Open Source projects, I'd recommend giving the token the smallest scope possible."
+        ui.say "This means only providing access to " + "public_info".yellow + " in the token.\n\n"
+        ui.pause 1
+        ui.say "This token limits Danger's abilities to just to writing comments on OSS projects. I recommend"
+        ui.say "this because the token can be quite easily be extracted from the environment via pull requests."
+        ui.say "#{@bot_name} does not need admin access to your repo. So it's ability to cause chaos is minimalized.\n"
+
+      elsif @is_open_source == "closed"
+        ui.say "For Closed Source projects, I'd recommend giving the token access to the whole repo scope."
+        ui.say "This means only providing access to " + "repo".yellow + ", and it's children in the token.\n\n"
+        ui.pause 1
+        ui.say "It's worth noting that you " + "should not".bold.white + " re-use this token for OSS repos. Make a new one for those repos with just " + "public_info".yellow + "."
+      end
+
+      ui.say "\n👍, please press return when you have your token set up…"
+      ui.wait_for_return
+    end
+
+    def considered_an_oss_repo?
+      @is_open_source == "open"
+    end
+
+    def current_repo_slug
+      @repo ||= Danger::CISource::LocalGitRepo.new
+      @repo.repo_slug || "[Your/Repo]"
+    end
+
+    def setup_danger_ci
+      ui.header 'Step 4: Add Danger for your CI'
+
+      uses_travis if File.exist? ".travis.yml"
+      uses_circle if File.exist? "circle.yml"
+      unsure_ci unless File.exist?(".travis.yml") || File.exist?(".circle.yml")
+
+      ui.say "\nOK, I'll give you a moment to do this…"
+      ui.wait_for_return
+
+      ui.say "Final step: exposing the GitHub token as a environment build variable."
+      ui.pause 0.4
+      if considered_an_oss_repo?
+        ui.say "As you have an Open Source repo, this token should be considered public, otherwise you cannot"
+        ui.say "run Danger on pull requests from forks, limiting it's use.\n"
+        ui.pause 1
+      end
+
+      travis_token if File.exist? ".travis.yml"
+      circle_token if File.exist? "circle.yml"
+      unsure_token unless File.exist?(".travis.yml") || File.exist?(".circle.yml")
+
+      ui.pause 0.6
+      ui.say "This is the last step, I can give you a second…"
+      ui.wait_for_return
+    end
+
+    def uses_travis
+      danger = "bundle exec danger".yellow
+      config = YAML.load(File.read(".travis.yml"))
+      if config["script"]
+        ui.say "Add " + "- ".yellow + danger + " as a new step in the " + "script".yellow + " section of your .travis.yml file."
+      else
+        ui.say "I'd recommend adding " + "script: ".yellow + danger + " to the script section of your .travis.yml file."
+      end
+
+      ui.pause 1
+      ui.say "You shouldn't use " + "after_success, after_failure, after_script".red + " as they cannot fail your builds."
+    end
+
+    def uses_circle
+      danger = "bundle exec danger".yellow
+      config = YAML.load(File.read("circle.yml"))
+
+      if config["test"]
+        if config["test"]["post"]
+          ui.say "Add " + danger + " as a new step in the " + "test:post:".yellow + " section of your circle.yml file."
+        else
+          ui.say "Add " + danger + " as a new step in the " + "test:override:".yellow + " section of your circle.yml file."
+        end
+      else
+        ui.say "Add this to the bottom of your circle.yml file:"
+        ui.say "test:".green
+        ui.say "  post:".green
+        ui.say "    - bundle exec danger".green
+      end
+    end
+
+    def unsure_ci
+      danger = "bundle exec danger".yellow
+      ui.say "As I'm not sure what CI you want to run Danger on base on the files in your repo, I'll just offer some generic"
+      ui.say "advice. You want to run " + danger + " after your tests have finished running, it should be during the testing"
+      ui.say "process so the build can fail."
+    end
+
+    def travis_token
+      # https://travis-ci.org/artsy/eigen/settings
+      ui.say "In order to add an environment variable, go to:"
+      ui.link "https://travis-ci.org/#{current_repo_slug}/settings"
+      ui.say "\nThe name is " + "DANGER_GITHUB_API_TOKEN".yellow + " and the value is the GitHub Personal Acess Token."
+      if @is_open_source
+        ui.say "Make sure to have \"Display value in build log\" enabled."
+      end
+    end
+
+    def circle_token
+      # https://circleci.com/gh/artsy/eigen/edit#env-vars
+      if considered_an_oss_repo?
+        ui.say "Before we start, it's important to be up-front. Circle CI only really has one option to support running Danger"
+        ui.say "for forks on OSS repos. It is quite a drastic option, and I want to let you know the best place to understand"
+        ui.say "the ramnifications for turning on a setting I'm about to advise.\n"
+        ui.link "https://circleci.com/docs/fork-pr-builds"
+        ui.say "TLDR: If you have anything other than Danger config settings in CircleCI, then you should not turn on the setting."
+        ui.say "I'll give you a minute to read it…"
+        ui.wait_for_return
+
+        ui.say "On Danger/Danger we turn on " + "Permissive building of fork pull requests".yellow + " this exposes the token to Danger"
+        ui.say "You can find this setting at:"
+        ui.link "https://circleci.com/gh/#{current_repo_slug}/edit#experimental\n"
+        ui.say "I'll hold…"
+        ui.wait_for_return
+      end
+
+      ui.say "In order to expose an environment variable, go to:"
+      ui.link "https://circleci.com/gh/#{repo_slug}/edit#env-vars"
+      ui.say "The name is " + "DANGER_GITHUB_API_TOKEN".yellow + " and the value is the GitHub Personal Acess Token."
+    end
+
+    def unsure_token
+      ui.say "You need to expose a token called " + "DANGER_GITHUB_API_TOKEN".yellow + " and the value is the GitHub Personal Acess Token."
+      ui.say "Depending on the CI system, this may need to be done on the machine ( in the " + "~/.bashprofile".yellow + ") or in a web UI somewhere."
+    end
+
+    def note_about_clicking_links
+      ui.say "Note: Holding cmd ( ⌘ ) and #{ENV['ITERM_SESSION_ID'] ? '' : 'double '}clicking a link will open it in your browser."
+    end
+
+    def info
+      ui.header "Useful info"
+      ui.say "- One of the best ways to test out new rules locally is via " + "bundle exec danger local".yellow + "."
+      ui.pause 0.6
+      ui.say "- You can have Danger output all of it's variables to the console via the " + "--verbose".yellow + "option."
+      ui.pause 0.6
+      ui.say "- You can look at the following Dangerfiles to get some more ideas:"
+      ui.pause 0.6
+      ui.link "https://github.com/danger/danger/blob/master/Dangerfile"
+      ui.link "https://github.com/artsy/eigen/blob/master/Dangerfile"
+      ui.pause 1
+    end
+
+    def thanks
+      ui.say "\n\n🎉"
+      ui.pause 0.6
+
+      ui.say "And you're set. Danger is a collaboration between Orta Therox, Gem 'Danger' McShane and Felix Krause."
+      ui.say "If you like it, let others know. If you want to know more, follow " + "@orta".yellow + " and " + "@krausefx".yellow + " on twitter."
+      ui.say "If you don't like it, help us improve it! xxx"
     end
   end
 end