Fixes #78: Project properties cannot be loaded anymore

Author: adangel

ReleaseNotes.md

@@ -15,6 +15,7 @@ Eclipse Update Site:
 
 *   [#70](https://github.com/pmd/pmd-eclipse-plugin/issues/70): UnsupportedOperationException opening Rule Configuration
 *   [#76](https://github.com/pmd/pmd-eclipse-plugin/issues/76): Global rule management is saved even if cancelled
+*   [#78](https://github.com/pmd/pmd-eclipse-plugin/issues/78): Project properties cannot be loaded anymore
 
 ### External Contributions
 

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/ProjectPropertiesModelTest.java

@@ -34,8 +34,11 @@
 
 package net.sourceforge.pmd.eclipse.runtime.properties;
 
+import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
+import java.io.InputStream;
 import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
 import java.util.Collection;
 import java.util.Iterator;
 
@@ -468,6 +471,63 @@ public void testRuleSetStoredInProjectTRUE() throws PropertiesException, RuleSet
         // projectRuleSet);
     }
 
+    /**
+     * Bug: when the project properties don't contain any rules, we should
+     * still be able to load the properties.
+     */
+    @Test
+    public void testNoRulesInProperties() throws PropertiesException, RuleSetNotFoundException, CoreException {
+        final IProjectPropertiesManager mgr = PMDPlugin.getDefault().getPropertiesManager();
+        IProjectProperties model = mgr.loadProjectProperties(this.testProject);
+        // remove PMD's cached project properties, so that we reload it from disk again
+        mgr.removeProjectProperties(this.testProject);
+
+        // overwrite the properties file
+        final IFile file = this.testProject.getFile(".pmd");
+        String propertiesContent = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+            + "<pmd>\n"
+            + "    <useProjectRuleSet>false</useProjectRuleSet>\n"
+            + "    <ruleSetFile>.ruleset</ruleSetFile>\n"
+            + "    <includeDerivedFiles>false</includeDerivedFiles>\n"
+            + "    <violationsAsErrors>true</violationsAsErrors>\n"
+            + "    <fullBuildEnabled>true</fullBuildEnabled>\n"
+            + "</pmd>\n";
+        InputStream propertiesStream = new ByteArrayInputStream(propertiesContent.getBytes(StandardCharsets.UTF_8));
+        file.setContents(propertiesStream, 0, null);
+
+        // reload the project properties
+        model = mgr.loadProjectProperties(this.testProject);
+        Assert.assertFalse(model.isRuleSetStoredInProject());
+        RuleSets projectRuleSets = model.getProjectRuleSets();
+        Assert.assertNotNull(projectRuleSets);
+        Assert.assertEquals(1, projectRuleSets.getAllRuleSets().length);
+        Assert.assertEquals(0, projectRuleSets.getAllRules().size());
+    }
+
+    /**
+     * Bug: when the project properties are invalid, we should handle the error correctly
+     * as a PropertiesException.
+     */
+    @Test(expected = PropertiesException.class)
+    public void testInvalidProperties() throws PropertiesException, RuleSetNotFoundException, CoreException {
+        final IProjectPropertiesManager mgr = PMDPlugin.getDefault().getPropertiesManager();
+        IProjectProperties model = mgr.loadProjectProperties(this.testProject);
+        // remove PMD's cached project properties, so that we reload it from disk again
+        mgr.removeProjectProperties(this.testProject);
+
+        // overwrite the properties file
+        final IFile file = this.testProject.getFile(".pmd");
+        String propertiesContent = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+            + "<pmd>\n"
+            + "    <invalid xml"
+            + "</pmd>\n";
+        InputStream propertiesStream = new ByteArrayInputStream(propertiesContent.getBytes(StandardCharsets.UTF_8));
+        file.setContents(propertiesStream, 0, null);
+
+        // reload the project properties
+        model = mgr.loadProjectProperties(this.testProject);
+    }
+
     private void dumpRuleSet(final RuleSet ruleSet) {
         System.out.println("Dumping rule set:" + ruleSet.getName());
         for (final Rule rule : ruleSet.getRules()) {

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/ProjectPropertiesManagerImpl.java

@@ -41,6 +41,7 @@
 import java.io.IOException;
 import java.io.StringReader;
 import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -210,7 +211,7 @@ private ProjectPropertiesTO readProjectProperties(final IProject project) throws
 
             final IFile propertiesFile = project.getFile(PROPERTIES_FILE);
             if (propertiesFile.exists() && propertiesFile.isAccessible()) {
-                String properties = IOUtils.toString(propertiesFile.getContents());
+                String properties = IOUtils.toString(propertiesFile.getContents(), StandardCharsets.UTF_8);
                 projectProperties = convertProjectPropertiesFromString(properties);
             }
 
@@ -220,6 +221,8 @@ private ProjectPropertiesTO readProjectProperties(final IProject project) throws
             throw new PropertiesException(e);
         } catch (CoreException e) {
             throw new PropertiesException(e);
+        } catch (DataBindingException e) {
+            throw new PropertiesException(e);
         }
     }
 
@@ -268,11 +271,13 @@ private void setRuleSetFromProperties(IProjectProperties projectProperties, Rule
 
         // de-duplicate rules
         Set<String> ruleNamesToAdd = new HashSet<>();
-        for (RuleSpecTO rule : rules) {
-            if (!ruleNamesToAdd.add(rule.getName())) {
-                PMDPlugin.getDefault()
-                        .logInformation("Duplicated Rule found: " + rule.getName() + ". This rule will be ignored.");
-                LOG.debug("Duplicated Rule found: " + rule.getName() + ". This rule will be ignored.");
+        if (rules != null) {
+            for (RuleSpecTO rule : rules) {
+                if (!ruleNamesToAdd.add(rule.getName())) {
+                    PMDPlugin.getDefault()
+                            .logInformation("Duplicated Rule found: " + rule.getName() + ". This rule will be ignored.");
+                    LOG.debug("Duplicated Rule found: " + rule.getName() + ". This rule will be ignored.");
+                }
             }
         }
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/properties/PMDPropertyPageController.java

@@ -51,7 +51,9 @@
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.cmd.BuildProjectCommand;
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties;
+import net.sourceforge.pmd.eclipse.runtime.properties.IProjectPropertiesManager;
 import net.sourceforge.pmd.eclipse.runtime.properties.PropertiesException;
+import net.sourceforge.pmd.eclipse.runtime.properties.impl.PropertiesFactoryImpl;
 import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
 
 import name.herlin.command.CommandException;
@@ -109,9 +111,22 @@ public PMDPropertyPageBean getPropertyPageBean() {
 
         if (this.propertyPageBean == null) {
             LOG.debug("Building a property page bean");
+            IProjectProperties properties;
+
             try {
-                final IProjectProperties properties = PMDPlugin.getDefault().loadProjectProperties(this.project);
+                properties = PMDPlugin.getDefault().loadProjectProperties(this.project);
+            } catch (PropertiesException e) {
+                PMDPlugin.getDefault().showError("Error loading project properties. Recreating empty properties.", e);
+                IProjectPropertiesManager propertiesManager = PMDPlugin.getDefault().getPropertiesManager();
+                properties = new PropertiesFactoryImpl().newProjectProperties(project, propertiesManager);
+                try {
+                    propertiesManager.storeProjectProperties(properties);
+                } catch (PropertiesException e1) {
+                    PMDPlugin.getDefault().showError(e.getMessage(), e);
+                }
+            }
 
+            try {
                 propertyPageBean = new PMDPropertyPageBean();
                 propertyPageBean.setPmdEnabled(properties.isPmdEnabled());
                 propertyPageBean.setProjectWorkingSet(properties.getProjectWorkingSet());
@@ -122,7 +137,6 @@ public PMDPropertyPageBean getPropertyPageBean() {
                 propertyPageBean.setFullBuildEnabled(properties.isFullBuildEnabled());
                 propertyPageBean.setViolationsAsErrors(properties.violationsAsErrors());
                 pmdAlreadyActivated = properties.isPmdEnabled();
-
             } catch (PropertiesException e) {
                 PMDPlugin.getDefault().showError(e.getMessage(), e);
             }