Allow to skip tests requiring Ctags with @ConditionalRun (#2100)

fixes #2088

Author: ahornace

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

@@ -18,7 +18,7 @@
  */
 
  /*
-  * Copyright (c) 2006, 2017, Oracle and/or its affiliates. All rights reserved.
+  * Copyright (c) 2006, 2018, Oracle and/or its affiliates. All rights reserved.
   * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
   */
 package org.opensolaris.opengrok.configuration;
@@ -654,7 +654,7 @@ public boolean validateExuberantCtags() {
             Executor executor = new Executor(new String[]{getCtags(), "--version"});
             executor.exec(false);
             String output = executor.getOutputString();
-            boolean isUnivCtags = output!=null?output.contains("Universal Ctags"):false;
+            boolean isUnivCtags = output != null && output.contains("Universal Ctags");
             if (output == null || (!output.contains("Exuberant Ctags") && !isUnivCtags)) {
                 LOGGER.log(Level.SEVERE, "Error: No Exuberant Ctags found in PATH !\n"
                         + "(tried running " + "{0}" + ")\n"

test/org/opensolaris/opengrok/analysis/CtagsTest.java

@@ -25,27 +25,30 @@
 package org.opensolaris.opengrok.analysis;
 
 import java.io.File;
-import java.io.IOException;
-import org.junit.After;
 import org.junit.AfterClass;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
-import org.junit.Before;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
+import org.opensolaris.opengrok.condition.ConditionalRun;
+import org.opensolaris.opengrok.condition.ConditionalRunRule;
+import org.opensolaris.opengrok.condition.CtagsInstalled;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.util.TestRepository;
 
 /**
  *
  * @author Lubos Kosco
  */
-public class CtagsTest {    
+@ConditionalRun(CtagsInstalled.class)
+public class CtagsTest {
+
     private static Ctags ctags;
     private static TestRepository repository;
 
-    public CtagsTest() {
-    }
+    @Rule
+    public ConditionalRunRule rule = new ConditionalRunRule();
 
     @BeforeClass
     public static void setUpClass() throws Exception {
@@ -65,9 +68,6 @@ public static void setUpClass() throws Exception {
         String extraOptionsFile =
                 repository.getSourceRoot() + "/bug19195/ctags.config";
         ctags.setCTagsExtraOptionsFile(extraOptionsFile);
-
-        assertTrue("No point in running ctags tests without valid ctags",
-                RuntimeEnvironment.getInstance().validateExuberantCtags());
     }
 
     @AfterClass
@@ -78,17 +78,9 @@ public static void tearDownClass() throws Exception {
         repository = null;
     }
 
-    @Before
-    public void setUp() throws IOException {        
-    }
-
-    @After
-    public void tearDown() {        
-    }
-
     /**
      * Helper method that gets the definitions for a file in the repository.
-     * @param file file name relative to source root
+     * @param fileName file name relative to source root
      * @return the definitions found in the file
      */
     private static Definitions getDefs(String fileName) throws Exception {

test/org/opensolaris/opengrok/analysis/JFlexXrefTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2018, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 
@@ -39,6 +39,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
 import org.opensolaris.opengrok.analysis.c.CXref;
 import org.opensolaris.opengrok.analysis.c.CxxXref;
@@ -57,6 +58,9 @@
 import org.opensolaris.opengrok.analysis.sql.SQLXref;
 import org.opensolaris.opengrok.analysis.tcl.TclXref;
 import org.opensolaris.opengrok.analysis.uue.UuencodeXref;
+import org.opensolaris.opengrok.condition.ConditionalRun;
+import org.opensolaris.opengrok.condition.ConditionalRunRule;
+import org.opensolaris.opengrok.condition.CtagsInstalled;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import static org.opensolaris.opengrok.util.CustomAssertions.assertLinesEqual;
 import org.opensolaris.opengrok.util.TestRepository;
@@ -70,6 +74,9 @@ public class JFlexXrefTest {
     private static Ctags ctags;
     private static TestRepository repository;
 
+    @Rule
+    public ConditionalRunRule rule = new ConditionalRunRule();
+
     /**
      * This is what we expect to find at the beginning of the first line
      * returned by an xref.
@@ -160,6 +167,7 @@ private void bug15890LineCount(JFlexNonXref xref) throws Exception {
      * used to cause trouble.
      */
     @Test
+    @ConditionalRun(CtagsInstalled.class)
     public void testBug15890Anchor() throws Exception {
         bug15890Anchor(CXref.class, "c/bug15890.c");
         bug15890Anchor(CxxXref.class, "c/bug15890.c");
@@ -377,6 +385,7 @@ public void testEmptyJavaComment() throws IOException {
     }
 
     @Test
+    @ConditionalRun(CtagsInstalled.class)
     public void bug18586() throws IOException, InterruptedException {
         String filename = repository.getSourceRoot() + "/sql/bug18586.sql";
         Reader in = new InputStreamReader(new FileInputStream(filename), "UTF-8");
@@ -391,6 +400,7 @@ public void bug18586() throws IOException, InterruptedException {
      * This originally became a problem after upgrade to JFlex 1.5.0.
      */
     @Test
+    @ConditionalRun(CtagsInstalled.class)
     public void unterminatedHeredoc() throws IOException {
         JFlexXref xref = new JFlexXref(new ShXref(new StringReader(
                 "cat << EOF\nunterminated heredoc")));

test/org/opensolaris/opengrok/analysis/c/CAnalyzerFactoryTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2018 Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis.c;
@@ -40,12 +40,16 @@
 import org.apache.lucene.index.IndexableField;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
 import org.opensolaris.opengrok.analysis.Ctags;
 import org.opensolaris.opengrok.analysis.FileAnalyzer;
 import org.opensolaris.opengrok.analysis.Scopes;
 import org.opensolaris.opengrok.analysis.Scopes.Scope;
 import org.opensolaris.opengrok.analysis.StreamSource;
+import org.opensolaris.opengrok.condition.ConditionalRun;
+import org.opensolaris.opengrok.condition.ConditionalRunRule;
+import org.opensolaris.opengrok.condition.CtagsInstalled;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.search.QueryBuilder;
 import org.opensolaris.opengrok.util.TestRepository;
@@ -54,12 +58,16 @@
  *
  * @author Tomas Kotal
  */
+@ConditionalRun(CtagsInstalled.class)
 public class CAnalyzerFactoryTest {
 
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
 
+    @Rule
+    public ConditionalRunRule rule = new ConditionalRunRule();
+
     private static StreamSource getStreamSource(final String fname) {
         return new StreamSource() {
             @Override

test/org/opensolaris/opengrok/analysis/c/CxxAnalyzerFactoryTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2015, 2016 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2018 Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis.c;
@@ -40,12 +40,16 @@
 import org.apache.lucene.index.IndexableField;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
 import org.opensolaris.opengrok.analysis.Ctags;
 import org.opensolaris.opengrok.analysis.FileAnalyzer;
 import org.opensolaris.opengrok.analysis.Scopes;
 import org.opensolaris.opengrok.analysis.Scopes.Scope;
 import org.opensolaris.opengrok.analysis.StreamSource;
+import org.opensolaris.opengrok.condition.ConditionalRun;
+import org.opensolaris.opengrok.condition.ConditionalRunRule;
+import org.opensolaris.opengrok.condition.CtagsInstalled;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.search.QueryBuilder;
 import org.opensolaris.opengrok.util.TestRepository;
@@ -54,12 +58,16 @@
  *
  * @author Tomas Kotal
  */
+@ConditionalRun(CtagsInstalled.class)
 public class CxxAnalyzerFactoryTest {
 
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
 
+    @Rule
+    public ConditionalRunRule rule = new ConditionalRunRule();
+
     private static StreamSource getStreamSource(final String fname) {
         return new StreamSource() {
             @Override

test/org/opensolaris/opengrok/analysis/clojure/ClojureAnalyzerFactoryTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2018 Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis.clojure;
@@ -27,11 +27,15 @@
 import org.apache.lucene.document.Field;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
 import org.opensolaris.opengrok.analysis.Ctags;
 import org.opensolaris.opengrok.analysis.Definitions;
 import org.opensolaris.opengrok.analysis.FileAnalyzer;
 import org.opensolaris.opengrok.analysis.StreamSource;
+import org.opensolaris.opengrok.condition.ConditionalRun;
+import org.opensolaris.opengrok.condition.ConditionalRunRule;
+import org.opensolaris.opengrok.condition.CtagsInstalled;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.search.QueryBuilder;
 import org.opensolaris.opengrok.util.TestRepository;
@@ -46,18 +50,21 @@
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
-
 import static org.opensolaris.opengrok.analysis.AnalyzerGuru.string_ft_nstored_nanalyzed_norms;
 
 /**
  * @author Farid Zakaria
  */
+@ConditionalRun(CtagsInstalled.class)
 public class ClojureAnalyzerFactoryTest {
 
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
 
+    @Rule
+    public ConditionalRunRule rule = new ConditionalRunRule();
+
     private static StreamSource getStreamSource(final String fname) {
         return new StreamSource() {
             @Override
@@ -127,5 +134,4 @@ public void testScopeAnalyzer() throws Exception {
         assertThat(type[0], is("definition"));
     }
 
-
 }

test/org/opensolaris/opengrok/analysis/csharp/CSharpAnalyzerFactoryTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2015, 2016 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2018 Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis.csharp;
@@ -33,6 +33,7 @@
 import org.apache.lucene.document.Field;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
 import static org.junit.Assert.*;
 import static org.opensolaris.opengrok.analysis.AnalyzerGuru.string_ft_nstored_nanalyzed_norms;
@@ -41,6 +42,9 @@
 import org.opensolaris.opengrok.analysis.Scopes;
 import org.opensolaris.opengrok.analysis.Scopes.Scope;
 import org.opensolaris.opengrok.analysis.StreamSource;
+import org.opensolaris.opengrok.condition.ConditionalRun;
+import org.opensolaris.opengrok.condition.ConditionalRunRule;
+import org.opensolaris.opengrok.condition.CtagsInstalled;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.search.QueryBuilder;
 import org.opensolaris.opengrok.util.TestRepository;
@@ -49,12 +53,16 @@
  *
  * @author Tomas Kotal
  */
+@ConditionalRun(CtagsInstalled.class)
 public class CSharpAnalyzerFactoryTest {
 
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
 
+    @Rule
+    public ConditionalRunRule rule = new ConditionalRunRule();
+
     private static StreamSource getStreamSource(final String fname) {
         return new StreamSource() {
             @Override