SONARGITUB-14 Fail if plugin is used in publish mode

Author: henryju

src/main/java/org/sonar/plugins/github/PullRequestProjectBuilder.java

@@ -20,7 +20,10 @@
 package org.sonar.plugins.github;
 
 import org.kohsuke.github.GHCommitState;
+import org.sonar.api.CoreProperties;
 import org.sonar.api.batch.bootstrap.ProjectBuilder;
+import org.sonar.api.config.Settings;
+import org.sonar.api.utils.MessageException;
 
 /**
  * Trigger load of pull request metadata at the very beginning of SQ analysis. Also
@@ -31,21 +34,31 @@ public class PullRequestProjectBuilder extends ProjectBuilder {
 
   private final GitHubPluginConfiguration gitHubPluginConfiguration;
   private final PullRequestFacade pullRequestFacade;
+  private final Settings settings;
 
-  public PullRequestProjectBuilder(GitHubPluginConfiguration gitHubPluginConfiguration, PullRequestFacade pullRequestFacade) {
+  public PullRequestProjectBuilder(GitHubPluginConfiguration gitHubPluginConfiguration, PullRequestFacade pullRequestFacade, Settings settings) {
     this.gitHubPluginConfiguration = gitHubPluginConfiguration;
     this.pullRequestFacade = pullRequestFacade;
+    this.settings = settings;
   }
 
   @Override
   public void build(Context context) {
     if (!gitHubPluginConfiguration.isEnabled()) {
       return;
     }
+    checkMode();
     int pullRequestNumber = gitHubPluginConfiguration.pullRequestNumber();
     pullRequestFacade.init(pullRequestNumber, context.projectReactor().getRoot().getBaseDir());
 
     pullRequestFacade.createOrUpdateSonarQubeStatus(GHCommitState.PENDING, "SonarQube analysis in progress");
   }
 
+  private void checkMode() {
+    if (!settings.getBoolean(CoreProperties.DRY_RUN)) {
+      throw MessageException.of("The GitHub plugin is only intended to be used in preview mode. Please set '" + CoreProperties.ANALYSIS_MODE + "'.");
+    }
+
+  }
+
 }

src/test/java/org/sonar/plugins/github/PullRequestProjectBuilderTest.java

@@ -0,0 +1,84 @@
+/*
+ * SonarQube :: GitHub Plugin
+ * Copyright (C) 2015 SonarSource
+ * sonarqube@googlegroups.com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.plugins.github;
+
+import java.io.File;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.sonar.api.CoreProperties;
+import org.sonar.api.batch.bootstrap.ProjectBuilder;
+import org.sonar.api.config.PropertyDefinitions;
+import org.sonar.api.config.Settings;
+import org.sonar.api.utils.MessageException;
+
+import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.RETURNS_DEEP_STUBS;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyZeroInteractions;
+import static org.mockito.Mockito.withSettings;
+
+public class PullRequestProjectBuilderTest {
+
+  @Rule
+  public ExpectedException thrown = ExpectedException.none();
+
+  private PullRequestProjectBuilder pullRequestProjectBuilder;
+  private PullRequestFacade facade;
+  private Settings settings;
+
+  @Before
+  public void prepare() {
+    settings = new Settings(new PropertyDefinitions(GitHubPlugin.class));
+    facade = mock(PullRequestFacade.class);
+    pullRequestProjectBuilder = new PullRequestProjectBuilder(new GitHubPluginConfiguration(settings), facade, settings);
+
+  }
+
+  @Test
+  public void shouldDoNothing() {
+    pullRequestProjectBuilder.build(null);
+    verifyZeroInteractions(facade);
+  }
+
+  @Test
+  public void shouldFailIfNotPreview() {
+    settings.setProperty(GitHubPlugin.GITHUB_PULL_REQUEST, "1");
+
+    thrown.expect(MessageException.class);
+    thrown.expectMessage("The GitHub plugin is only intended to be used in preview mode. Please set 'sonar.analysis.mode'.");
+
+    pullRequestProjectBuilder.build(null);
+  }
+
+  @Test
+  public void shouldNotFailIfPreview() {
+    settings.setProperty(GitHubPlugin.GITHUB_PULL_REQUEST, "1");
+    settings.setProperty(CoreProperties.DRY_RUN, "true");
+
+    pullRequestProjectBuilder.build(mock(ProjectBuilder.Context.class, withSettings().defaultAnswer(RETURNS_DEEP_STUBS)));
+
+    verify(facade).init(eq(1), any(File.class));
+
+  }
+}