Add org.sonar.api.utils.PathUtils

4 files changed, 136 insertions, 10 deletions

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/DefaultInputFile.java b/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/DefaultInputFile.java
index 2437ec35670..b56f99f2093 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/DefaultInputFile.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/DefaultInputFile.java
@@ -22,10 +22,10 @@ package org.sonar.api.scan.filesystem.internal;
 import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.lang.StringUtils;
 import org.sonar.api.scan.filesystem.InputFile;
+import org.sonar.api.utils.PathUtils;
 
 import javax.annotation.CheckForNull;
 import java.io.File;
-import java.io.IOException;
 import java.util.Map;
 
 /**
@@ -40,13 +40,9 @@ public class DefaultInputFile implements InputFile {
   private final Map<String, String> attributes;
 
   private DefaultInputFile(File file, String relativePath, Map<String, String> attributes) {
-    try {
-      this.path = FilenameUtils.separatorsToUnix(file.getCanonicalPath());
-      this.relativePath = FilenameUtils.separatorsToUnix(relativePath);
+    this.path = PathUtils.canonicalPath(file);
+    this.relativePath = FilenameUtils.separatorsToUnix(relativePath);
       this.attributes = attributes;
-    } catch (IOException e) {
-      throw new IllegalStateException("Fail to get canonical path of: " + file, e);
-    }
   }
 
   /**
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/InputFileBuilder.java b/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/InputFileBuilder.java
index 756d516728c..8a83437fd56 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/InputFileBuilder.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/scan/filesystem/internal/InputFileBuilder.java
@@ -19,8 +19,8 @@
  */
 package org.sonar.api.scan.filesystem.internal;
 
-import org.apache.commons.io.FilenameUtils;
 import org.sonar.api.scan.filesystem.InputFile;
+import org.sonar.api.utils.PathUtils;
 
 import javax.annotation.Nullable;
 import java.io.File;
@@ -75,11 +75,11 @@ public class InputFileBuilder {
   }
 
   public InputFileBuilder sourceDir(File dir) {
-    return sourceDir(dir.getAbsolutePath());
+    return attribute(InputFile.ATTRIBUTE_SOURCEDIR_PATH, PathUtils.canonicalPath(dir));
   }
 
   public InputFileBuilder sourceDir(@Nullable String path) {
-    return attribute(InputFile.ATTRIBUTE_SOURCEDIR_PATH, FilenameUtils.separatorsToUnix(path));
+    return attribute(InputFile.ATTRIBUTE_SOURCEDIR_PATH, PathUtils.sanitize(path));
   }
 
   public DefaultInputFile build() {
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/utils/PathUtils.java b/sonar-plugin-api/src/main/java/org/sonar/api/utils/PathUtils.java
new file mode 100644
index 00000000000..e1441279fb2
--- /dev/null
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/utils/PathUtils.java
@@ -0,0 +1,55 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2013 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube 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.
+ *
+ * SonarQube 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  02110-1301, USA.
+ */
+package org.sonar.api.utils;
+
+import org.apache.commons.io.FilenameUtils;
+
+import javax.annotation.Nullable;
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * @since 4.0
+ */
+public class PathUtils {
+
+  PathUtils() {
+    // only static methods
+  }
+
+  /**
+   * Normalize path and replace file separators by forward slash
+   */
+  public static String sanitize(@Nullable String path) {
+    return FilenameUtils.normalize(path, true);
+  }
+
+  /**
+   * Get canonical path and replace file separators by forward slash. This
+   * method does not throw boring checked exception.
+   */
+  public static String canonicalPath(@Nullable File file) {
+    try {
+      return file != null ? FilenameUtils.separatorsToUnix(file.getCanonicalPath()) : null;
+    } catch (IOException e) {
+      throw new IllegalStateException("Fail to get the canonical path of " + file.getAbsolutePath(), e);
+    }
+  }
+}
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/utils/PathUtilsTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/utils/PathUtilsTest.java
new file mode 100644
index 00000000000..5f7e1333261
--- /dev/null
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/utils/PathUtilsTest.java
@@ -0,0 +1,75 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2013 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube 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.
+ *
+ * SonarQube 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  02110-1301, USA.
+ */
+package org.sonar.api.utils;
+
+import org.apache.commons.io.FilenameUtils;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+
+import java.io.File;
+import java.io.IOException;
+import java.lang.reflect.Method;
+
+import static org.fest.assertions.Assertions.assertThat;
+import static org.fest.assertions.Fail.fail;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+/**
+ * @since 4.0
+ */
+public class PathUtilsTest {
+
+  @Rule
+  public TemporaryFolder temp = new TemporaryFolder();
+
+  @Test
+  public void testSanitize() throws Exception {
+    assertThat(PathUtils.sanitize("foo/bar/..")).isEqualTo("foo/");
+    assertThat(PathUtils.sanitize("C:\\foo\\..\\bar")).isEqualTo("C:/bar");
+  }
+
+  @Test
+  public void testCanonicalPath_unchecked_exception() throws Exception {
+    File file = mock(File.class);
+    when(file.getCanonicalPath()).thenThrow(new IOException());
+
+    try {
+      PathUtils.canonicalPath(file);
+      fail();
+    } catch (IllegalStateException e) {
+      assertThat(e.getCause()).isInstanceOf(IOException.class);
+    }
+  }
+
+  @Test
+  public void testCanonicalPath() throws Exception {
+    File file = temp.newFile();
+    String path = PathUtils.canonicalPath(file);
+    assertThat(path).isEqualTo(FilenameUtils.separatorsToUnix(file.getCanonicalPath()));
+  }
+
+  @Test
+  public void haveFunGetCoverage() throws Exception {
+    // does not fail
+    new PathUtils();
+  }
+}