fix encoding/decoding of IgnoredNames objects

fixes #1383

Author: vladak

src/org/opensolaris/opengrok/index/IgnoredDirs.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.index;
 
@@ -58,7 +58,7 @@ public IgnoredDirs() {
      * @return true if this file should be ignored, false otherwise
      */
     public boolean ignore(File file) {
-        return match(file) && file.isDirectory();
+        return file.isDirectory() && match(file);
     }
 
     /**

src/org/opensolaris/opengrok/index/IgnoredFiles.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2007, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.index;
 
@@ -72,7 +72,7 @@ public IgnoredFiles() {
      * @return true if this file should be ignored, false otherwise
      */
     public boolean ignore(File file) {
-        return match(file) && file.isFile();
+        return file.isFile() && match(file);
     }
 
     /**

src/org/opensolaris/opengrok/index/IgnoredNames.java

@@ -18,11 +18,12 @@
  */
 
 /*
- * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.index;
 
 import java.io.File;
+import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -31,10 +32,11 @@
  *
  * @author Vladimir Kotal
  */
-public class IgnoredNames {
+public class IgnoredNames implements Serializable {
+    private static final long serialVersionUID = 1L;
 
-    private final IgnoredFiles ignoredFiles;
-    private final IgnoredDirs ignoredDirs;
+    private IgnoredFiles ignoredFiles;
+    private IgnoredDirs ignoredDirs;
 
     public IgnoredNames() {
         ignoredFiles = new IgnoredFiles();
@@ -48,6 +50,13 @@ public List<String> getItems() {
         return twoLists;
     }
 
+    public void setItems(List<String> item) {
+        clear();
+        for (String s : item) {
+            add(s);
+        }
+    }
+
     public void add(String pattern) {
         if (pattern.startsWith("f:")) {
             ignoredFiles.add(pattern.substring(2));
@@ -59,13 +68,6 @@ public void add(String pattern) {
         }
     }
 
-    public void setItems(List<String> item) {
-        clear();
-        for (String s : item) {
-            add(s);
-        }
-    }
-
     /**
      * Should the file be ignored or not?
      *
@@ -94,4 +96,20 @@ public void clear() {
         ignoredFiles.clear();
         ignoredDirs.clear();
     }
+
+    public IgnoredDirs getIgnoredDirs() {
+        return ignoredDirs;
+    }
+
+    public IgnoredFiles getIgnoredFiles() {
+        return ignoredFiles;
+    }
+
+    public void setIgnoredDirs(IgnoredDirs i) {
+        ignoredDirs = i;
+    }
+
+    public void setIgnoredFiles(IgnoredFiles i) {
+        ignoredFiles = i;
+    }
 }

src/org/opensolaris/opengrok/index/Indexer.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
  *
  * Portions Copyright 2011 Jens Elkner.
  */
@@ -41,6 +41,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.stream.Collectors;
 import org.opensolaris.opengrok.Info;
 import org.opensolaris.opengrok.analysis.AnalyzerGuru;
 import org.opensolaris.opengrok.configuration.Configuration;
@@ -775,11 +776,12 @@ public int compare(Project p1, Project p2) {
             LOGGER.info("Done...");
         }
 
-         if (refreshHistory) {
-             if (repositories != null && !repositories.isEmpty()) {
-                  LOGGER.log(Level.INFO, "Generating history cache for specified repositories ...");
-                  HistoryGuru.getInstance().createCache(repositories);
-                  LOGGER.info("Done...");
+        if (refreshHistory) {
+            if (repositories != null && !repositories.isEmpty()) {
+                LOGGER.log(Level.INFO, "Generating history cache for repositories: " +
+                    repositories.stream().collect(Collectors.joining(",")));
+                HistoryGuru.getInstance().createCache(repositories);
+                LOGGER.info("Done...");
               } else {
                   LOGGER.log(Level.INFO, "Generating history cache for all repositories ...");
                   HistoryGuru.getInstance().createCache();

test/org/opensolaris/opengrok/index/IgnoredNamesTest.java

@@ -18,22 +18,34 @@
  */
 
 /*
- * Copyright (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.index;
 
+import java.beans.ExceptionListener;
+import java.beans.XMLDecoder;
+import java.beans.XMLEncoder;
+import java.io.BufferedOutputStream;
+import java.io.BufferedReader;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 
 import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
 import java.util.ArrayList;
+import java.util.LinkedList;
 import java.util.List;
+import junit.framework.AssertionFailedError;
 
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.opensolaris.opengrok.analysis.c.CAnalyzerFactoryTest;
+import org.opensolaris.opengrok.util.FileUtilities;
 import org.opensolaris.opengrok.util.TestRepository;
 
 /**
@@ -111,4 +123,70 @@ public void testIgnoredPatterns() {
         names = instance.getItems();
         assertEquals(0, names.size());
     }
+
+    /**
+     * Make sure that encoding and decoding IgnoredNames object is 1:1 operation.
+     * @throws FileNotFoundException
+     * @throws IOException 
+     */
+    @Test
+    public void testEncodeDecode() throws FileNotFoundException, IOException {
+        IgnoredNames in = new IgnoredNames();
+        // Add file and directory to list of ignored items.
+        in.add("f:foo.txt");
+        in.add("d:bar");
+
+        // Create an exception listener to detect errors while encoding and decoding
+        final LinkedList<Exception> exceptions = new LinkedList<Exception>();
+        ExceptionListener listener = new ExceptionListener() {
+            @Override
+            public void exceptionThrown(Exception e) {
+                exceptions.addLast(e);
+            }
+        };
+
+        // Actually create the file and directory for much better test coverage.
+        File tmpdir = FileUtilities.createTemporaryDirectory("ignoredNames");
+        File foo = new File(tmpdir, "foo.txt");
+        foo.createNewFile();
+        assertTrue(foo.isFile());
+        File bar = new File(tmpdir, "bar");
+        bar.mkdir();
+        assertTrue(bar.isDirectory());
+
+        // Store the IgnoredNames object as XML file.
+        File testXML = new File(tmpdir, "Test.xml");
+        XMLEncoder e = new XMLEncoder(new BufferedOutputStream(new FileOutputStream(testXML)));
+        e.setExceptionListener(listener);
+        e.writeObject(in);
+        e.close();
+
+        // Restore the IgnoredNames object from XML file.
+        XMLDecoder d = new XMLDecoder(new FileInputStream(testXML));
+        IgnoredNames in2 = (IgnoredNames) d.readObject();
+        d.close();
+
+        // Verify that the XML encoding/decoding did not fail.
+        if (!exceptions.isEmpty()) {
+            AssertionFailedError afe = new AssertionFailedError(
+                    "Got " + exceptions.size() + " exception(s)");
+            // Can only chain one of the exceptions. Take the first one.
+            afe.initCause(exceptions.getFirst());
+            throw afe;
+        }
+
+        // Make sure the complete list of items is equal after decoding.
+        // This will is a simple casual test that cannot verify that sub-classes
+        // are intact. For that there are the following tests.
+        assertTrue(in.getItems().containsAll(in2.getItems()));
+
+        // Use the restored object to test the matching of file and directory.
+        assertTrue(in2.ignore("foo.txt"));
+        assertTrue(in2.ignore("bar"));
+        assertTrue(in2.ignore(foo));
+        assertTrue(in2.ignore(bar));
+
+        // Cleanup.
+        FileUtilities.removeDirs(tmpdir);
+    }
 }