Add regression tests for canon_path and update CLI help text

3 files changed, 158 insertions, 17 deletions

diff --git a/fpm/src/fpm_command_line.f90 b/fpm/src/fpm_command_line.f90
index 92330da..1326ee5 100644
--- a/fpm/src/fpm_command_line.f90
+++ b/fpm/src/fpm_command_line.f90
@@ -673,14 +673,16 @@ contains
     '    install [--profile PROF] [--flag FFLAGS] [--no-rebuild] [--prefix PATH] [options]', &
     '                                                                       ', &
     'SUBCOMMAND OPTIONS                                                     ', &
-    '  --profile PROF Builds or runs with the given profile (either release or debug).', &
-    '                 fpm(1) defaults to using common compiler debug flags with debug', &
-    '                 profile, common compiler optimization flags are used with the', &
-    '                 release profile', &
-    '  --flag FFLAGS  Use compile arguments provided in FFLAGS rather than', &
-    '                 defaults, if a profile (debug or release) is present the', &
-    '                 FFLAGS are appended rather than replaced, module flags are', &
-    '                 provided by fpm(1) and must not be present in FFLAGS', &
+    ' --profile PROF    selects the compilation profile for the build.',&
+    '                   Currently available profiles are "release" for',&
+    '                   high optimization and "debug" for full debug options.',&
+    '                   If --flag is not specified the "debug" flags are the',&
+    '                   default. ',&
+    ' --flag  FFLAGS    selects compile arguments for the build. These are',&
+    '                   added to the profile options if --profile is specified,',&
+    '                   else these options override the defaults.',&
+    '                   Note object and .mod directory locations are always',&
+    '                   built in.',&
     '  --list     List candidates instead of building or running them. On   ', &
     '             the fpm(1) command this shows a brief list of subcommands.', &
     '  --runner CMD   Provides a command to prefix program execution paths. ', &
@@ -765,8 +767,16 @@ contains
     '                   the special characters from shell expansion.        ', &
     ' --all   Run all examples or applications. An alias for --target ''*''.  ', &
     ' --example  Run example programs instead of applications.              ', &
-    ' --profile PROF    Selects the compilation profile for the build.      ', &
-    ' --flags FFLAGS    selects compile arguments for the build', &
+    ' --profile PROF    selects the compilation profile for the build.',&
+    '                   Currently available profiles are "release" for',&
+    '                   high optimization and "debug" for full debug options.',&
+    '                   If --flag is not specified the "debug" flags are the',&
+    '                   default. ',&
+    ' --flag  FFLAGS    selects compile arguments for the build. These are',&
+    '                   added to the profile options if --profile is specified,',&
+    '                   else these options override the defaults.',&
+    '                   Note object and .mod directory locations are always',&
+    '                   built in.',&
     ' --compiler COMPILER_NAME  Specify a compiler name. The default is     ', &
     '                           "gfortran" unless set by the environment    ', &
     '                           variable FPM_COMPILER.                      ', &
@@ -829,9 +839,16 @@ contains
     ' specified in the "fpm.toml" file.                                     ', &
     '                                                                       ', &
     'OPTIONS                                                                ', &
-    ' --profile PROF  selects the compilation profile for the build         ', &
-    '              high optimization instead of full debug options.         ', &
-    ' --flags FFLAGS  selects compile arguments for the build', &
+    ' --profile PROF    selects the compilation profile for the build.',&
+    '                   Currently available profiles are "release" for',&
+    '                   high optimization and "debug" for full debug options.',&
+    '                   If --flag is not specified the "debug" flags are the',&
+    '                   default. ',&
+    ' --flag  FFLAGS    selects compile arguments for the build. These are',&
+    '                   added to the profile options if --profile is specified,',&
+    '                   else these options override the defaults.',&
+    '                   Note object and .mod directory locations are always',&
+    '                   built in.',&
     ' --compiler   COMPILER_NAME  Specify a compiler name. The default is   ', &
     '                           "gfortran" unless set by the environment    ', &
     '                           variable FPM_COMPILER.                      ', &
@@ -1005,8 +1022,16 @@ contains
     '                   any single character and "*" represents any string. ', &
     '                   Note The glob string normally needs quoted to       ', &
     '                   protect the special characters from shell expansion.', &
-    ' --profile PROF  selects the compilation profile for the build.', &
-    ' --flags FFLAGS  selects compile arguments for the build', &
+    ' --profile PROF    selects the compilation profile for the build.',&
+    '                   Currently available profiles are "release" for',&
+    '                   high optimization and "debug" for full debug options.',&
+    '                   If --flag is not specified the "debug" flags are the',&
+    '                   default. ',&
+    ' --flag  FFLAGS    selects compile arguments for the build. These are',&
+    '                   added to the profile options if --profile is specified,',&
+    '                   else these options override the defaults.',&
+    '                   Note object and .mod directory locations are always',&
+    '                   built in.',&
     ' --compiler COMPILER_NAME  Specify a compiler name. The default is     ', &
     '                           "gfortran" unless set by the environment    ', &
     '                           variable FPM_COMPILER.                      ', &
@@ -1069,8 +1094,16 @@ contains
     'OPTIONS', &
     ' --list            list all installable targets for this project,', &
     '                   but do not install any of them', &
-    ' --profile         selects the compilation profile for installation', &
-    ' --flags FFLAGS    selects compile arguments for the build', &
+    ' --profile PROF    selects the compilation profile for the build.',&
+    '                   Currently available profiles are "release" for',&
+    '                   high optimization and "debug" for full debug options.',&
+    '                   If --flag is not specified the "debug" flags are the',&
+    '                   default. ',&
+    ' --flag  FFLAGS    selects compile arguments for the build. These are',&
+    '                   added to the profile options if --profile is specified,',&
+    '                   else these options override the defaults.',&
+    '                   Note object and .mod directory locations are always',&
+    '                   built in.',&
     ' --no-rebuild      do not rebuild project before installation', &
     ' --prefix DIR      path to installation directory (requires write access),', &
     '                   the default prefix on Unix systems is $HOME/.local', &
diff --git a/fpm/test/fpm_test/main.f90 b/fpm/test/fpm_test/main.f90
index e1b9d1e..0a65307 100644
--- a/fpm/test/fpm_test/main.f90
+++ b/fpm/test/fpm_test/main.f90
@@ -5,6 +5,7 @@ program fpm_testing
         & select_suite, run_selected
     use test_toml, only : collect_toml
     use test_manifest, only : collect_manifest
+    use test_filesystem, only : collect_filesystem
     use test_source_parsing, only : collect_source_parsing
     use test_module_dependencies, only : collect_module_dependencies
     use test_package_dependencies, only : collect_package_dependencies
@@ -22,6 +23,7 @@ program fpm_testing
     suite = [ &
         & new_testsuite("fpm_toml", collect_toml), &
         & new_testsuite("fpm_manifest", collect_manifest), &
+        & new_testsuite("fpm_filesystem", collect_filesystem), &
         & new_testsuite("fpm_source_parsing", collect_source_parsing), &
         & new_testsuite("fpm_module_dependencies", collect_module_dependencies), &
         & new_testsuite("fpm_package_dependencies", collect_package_dependencies), &
diff --git a/fpm/test/fpm_test/test_filesystem.f90 b/fpm/test/fpm_test/test_filesystem.f90
new file mode 100644
index 0000000..5a7e18a
--- /dev/null
+++ b/fpm/test/fpm_test/test_filesystem.f90
@@ -0,0 +1,106 @@
+module test_filesystem
+    use testsuite, only : new_unittest, unittest_t, error_t, test_failed
+    use fpm_filesystem, only: canon_path
+    implicit none
+    private
+
+    public :: collect_filesystem
+
+contains
+
+
+    !> Collect all exported unit tests
+    subroutine collect_filesystem(testsuite)
+
+        !> Collection of tests
+        type(unittest_t), allocatable, intent(out) :: testsuite(:)
+
+        testsuite = [ &
+            & new_unittest("canon-path", test_canon_path) &
+            ]
+            
+    end subroutine collect_filesystem
+
+
+    subroutine test_canon_path(error)
+
+        !> Error handling
+        type(error_t), allocatable, intent(out) :: error
+
+        call check_string(error, &
+            & canon_path("git/project/src/origin"), "git/project/src/origin")
+        if (allocated(error)) return
+
+        call check_string(error,  &
+            & canon_path("./project/src/origin"), "project/src/origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("./project/src///origin/"), "project/src/origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("../project/./src/origin/"), "../project/src/origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("/project//src/origin/"), "/project/src/origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("/project/src/../origin/"), "/project/origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("/project/src/../origin/.."), "/project")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("/project/src//../origin/."), "/project/origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("../project/src/./../origin/."), "../project/origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("../project/src/../../../origin/."), "../../origin")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("/../.."), "/")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("././././././/////a/b/.///././////.///c/../../../"), ".")
+        if (allocated(error)) return
+
+        call check_string(error, &
+            & canon_path("/./././././/////a/b/.///././////.///c/../../../"), "/")
+        if (allocated(error)) return
+
+    end subroutine test_canon_path
+
+
+    !> Check a character variable against a reference value
+    subroutine check_string(error, actual, expected)
+
+        !> Error handling
+        type(error_t), allocatable, intent(out) :: error
+
+        !> Actual string value
+        character(len=*), intent(in) :: actual
+
+        !> Expected string value
+        character(len=*), intent(in) :: expected
+
+        if (actual /= expected) then
+            call test_failed(error, &
+                "Character value missmatch "//&
+                "expected '"//expected//"' but got '"//actual//"'")
+        end if
+
+    end subroutine check_string
+
+
+end module test_filesystem