add support for symlinked install on windows #6

dirk-thomas · 2015-03-21T00:11:18Z

@wjwwood Whenever you have time to try it.

tfoote · 2015-03-25T18:59:51Z

I tried running the build with

python src\ament\ament_tools\scripts\ament.py build --symlink-install

And I got the following error:

PostBuildEvent:
  setlocal
  C:\ProgramData\chocolatey\lib\cmake.3.1.3\content\cmake-3.1.3-win32-x86\bin\c
  make.exe -DBUILD_TYPE=Debug -P cmake_install.cmake
  if %errorlevel% neq 0 goto :cmEnd
  :cmEnd
  endlocal & call :cmErrorLevel %errorlevel% & goto :cmDone
  :cmErrorLevel
  exit /b %1
  :cmDone
  if %errorlevel% neq 0 goto :VCEnd
  :VCEnd
  -- Install configuration: "Debug"
  -- Symlinking: C:/Users/Administrator/work/test/install/local_setup.bash
   - Execute custom install script
  CMake Error at ament_cmake_symlink_install/ament_cmake_symlink_install.cmake:
  287 (message):
    Could not create symlink
    'C:/Users/Administrator/work/test/install/local_setup.bash' pointing to
    'c:/users/administrator/work/test/build/ament_package/ament_package/templat
  e/prefix_level/local_setup.bash'
  Call Stack (most recent call first):
    ament_cmake_symlink_install/ament_cmake_symlink_install.cmake:130 (_ament_c
  make_symlink_create_symlink)
    ament_cmake_symlink_install/ament_cmake_symlink_install.cmake:299 (ament_cm
  ake_symlink_install_files)
    cmake_install.cmake:31 (include)


Build FAILED.

"C:\Users\Administrator\work\test\build\ament_cmake_core\INSTALL.vcxproj" (defa
ult target) (1) ->
(PostBuildEvent target) ->
  C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.ta
rgets(132,5): error MSB3073: The command "setlocal\r [C:\Users\Administrator\wo
rk\test\build\ament_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: C:\ProgramData\chocolatey\lib\cmake.3.1.3\content\cm
ake-3.1.3-win32-x86\bin\cmake.exe -DBUILD_TYPE=Debug -P cmake_install.cmake\r [
C:\Users\Administrator\work\test\build\ament_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: if %errorlevel% neq 0 goto :cmEnd\r [C:\Users\Admini
strator\work\test\build\ament_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: :cmEnd\r [C:\Users\Administrator\work\test\build\ame
nt_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: endlocal & call :cmErrorLevel %errorlevel% & goto :c
mDone\r [C:\Users\Administrator\work\test\build\ament_cmake_core\INSTALL.vcxpro
j]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: :cmErrorLevel\r [C:\Users\Administrator\work\test\bu
ild\ament_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: exit /b %1\r [C:\Users\Administrator\work\test\build
\ament_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: :cmDone\r [C:\Users\Administrator\work\test\build\am
ent_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: if %errorlevel% neq 0 goto :VCEnd\r [C:\Users\Admini
strator\work\test\build\ament_cmake_core\INSTALL.vcxproj]
C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140\Microsoft.CppCommon.targ
ets(132,5): error MSB3073: :VCEnd" exited with code 1. [C:\Users\Administrator\
work\test\build\ament_cmake_core\INSTALL.vcxproj]

    0 Warning(s)
    1 Error(s)

Time Elapsed 00:00:01.70

<== Command 'C:\Users\Administrator\work\test\build\ament_cmake_core\ament_cmake
__install.bat C:\Program Files (x86)\MSBuild\14.0\bin\amd64\msbuild.EXE C:\Users
\Administrator\work\test\build\ament_cmake_core\INSTALL.vcxproj' failed with exi
t code '1'

dirk-thomas · 2015-03-25T19:08:06Z

Can you please look at the specific install command (ament_cmake_symlink_install/ament_cmake_symlink_install.cmake:287), run it in a shell and check what it does / output / returncode?

wjwwood · 2015-03-25T19:12:29Z

You need elevated permissions to create symlinks on windows as well, see: https://docs.python.org/3.4/library/os.html#os.symlink (note about Windows and SeCreateSymbolicLinkPrivilege)

dirk-thomas · 2015-03-25T19:23:03Z

Sure, but we could detect if the permission is available or not based on the error code. We can always fall back to:

a reasonable error / warning message
hard links
copying the file

But this needs to be debugged on Windows to gather the necessary information:

what the error codes when the permissions are not available?
are they different than for any other error?
if the CMake check IS_SYMLINK still working? also for hard links?

wjwwood · 2015-03-26T21:35:35Z

I just rebased and force pushed this branch so it has the latest changes.

tfoote · 2015-03-26T21:38:24Z

I'm running as Administrator so don't have the permissions issues.

wjwwood · 2015-03-26T21:39:45Z

When running without "Run as administrator..." I get this:

+++ Building 'ament_copyright'
+++ Installing 'ament_copyright'
Traceback (most recent call last):
  File "src\ament\ament_tools\scripts\ament.py", line 111, in <module>
    sys.exit(main() or 0)
  File "C:\dev\ros2\src\ament\ament_tools\ament_tools\commands\ament.py", line 88, in main
    rc = args.main(args)
  File "C:\dev\ros2\src\ament\ament_tools\ament_tools\verbs\build\cli.py", line 138, in main
    iterate_packages(opts, packages, per_package_main)
  File "C:\dev\ros2\src\ament\ament_tools\ament_tools\verbs\build\cli.py", line 190, in iterate_packages
    rc = per_package_callback(opts)
  File "C:\dev\ros2\src\ament\ament_tools\ament_tools\verbs\build_pkg\cli.py", line 284, in main
    handle_build_action(on_install_ret, context)
  File "C:\dev\ros2\src\ament\ament_tools\ament_tools\verbs\build_pkg\cli.py", line 259, in handle_build_action
    build_action.cmd(context)
  File "C:\dev\ros2\src\ament\ament_tools\ament_tools\build_types\ament_python.py", line 393, in _install_action_python
    os.symlink(src, dst)
OSError: symbolic link privilege not held

I'm trying with admin now.

wjwwood · 2015-03-26T21:40:30Z

With admin:

  -- Install configuration: "Debug"
   - Execute custom install script
  -- Symlinking: C:/dev/ros2/install/local_setup.bash
  CMake Error at ament_cmake_symlink_install/ament_cmake_symlink_install.cmake:287 (message):
    Could not create symlink 'C:/dev/ros2/install/local_setup.bash' pointing to
    'c:/dev/ros2/build/ament_package/ament_package/template/prefix_level/local_setup.bash'
  Call Stack (most recent call first):
    ament_cmake_symlink_install/ament_cmake_symlink_install.cmake:130 (_ament_cmake_symlink_create_symlink)
    ament_cmake_symlink_install/ament_cmake_symlink_install.cmake:299 (ament_cmake_symlink_install_files)
    cmake_install.cmake:31 (include)

The IS_SYMLINK check in CMake doesn't appear to work on Windows, so I've disable the shortcut check on Windows. Also, I've changed the error checking on Windows and changed the way mklink is executed, instead executing it with cmd /C.

This still doesn't work because the generator expressions are not expanded in time to be used by execute_process. We might try using add_custom_command instead which supposedly works with generator expressions.

dirk-thomas · 2015-03-28T23:08:53Z

ament_cmake_core/cmake/symlink_install/ament_cmake_symlink_install.cmake.in

+    endif()
+  else()
+    string(REPLACE "/" "\\" symlink "${symlink}")
+    string(REPLACE "/" "\\" absolute_file "${absolute_file}")


Please use file(TO_NATIVE_PATH for these kind of conversions.

That's right, but those lines may not end up being needed. This pull request isn't really ready for review since it isn't working yet.

wjwwood · 2015-03-31T20:59:23Z

This still doesn't work because the generator expressions are not expanded in time to be used by execute_process. We might try using add_custom_command instead which supposedly works with generator expressions.

However, this is not high priority so we're pushing it back to the backlog.

mikaelarguedas · 2018-02-22T19:41:09Z

@wjwwood @dirk-thomas what is the resolution on this? that symlink installation is not possible on Windows without admin privileges and that this PR should be closed?

dirk-thomas · 2018-02-22T21:31:00Z

Imo this could still be implemented as described. When the user has the privilege create symlinks, otherwise either fail with a reasonable error message or fall back to not use symlinks.

wjwwood · 2018-02-22T21:33:11Z

I agree, so in light of that I think my previous comment still applies: currently doesn't work, might be fixed with another alternative, not high enough priority to try for now.

mikaelarguedas · 2018-02-22T21:35:38Z

sounds good thanks for the follow-up

hidmic · 2020-10-16T22:07:03Z

@dirk-thomas is this still a valid PR?

dirk-thomas · 2020-10-16T22:16:00Z

It would still be a good feature to have on Windows. I am not planning to spend any time on it though.

dirk-thomas added the in progress Actively being worked on (Kanban column) label Mar 21, 2015

dirk-thomas self-assigned this Mar 21, 2015

dirk-thomas added in review Waiting for review (Kanban column) and removed in progress Actively being worked on (Kanban column) labels Mar 21, 2015

add support for symlinked install on windows

3f22de3

wjwwood force-pushed the symlink_windows branch from d805ce0 to 3f22de3 Compare March 26, 2015 21:35

wjwwood added 2 commits March 27, 2015 13:54

fixup symlink on Windows

5b0ee58

The IS_SYMLINK check in CMake doesn't appear to work on Windows, so I've disable the shortcut check on Windows. Also, I've changed the error checking on Windows and changed the way mklink is executed, instead executing it with cmd /C.

[wip] use generator expressions with linking

122367b

This still doesn't work because the generator expressions are not expanded in time to be used by execute_process. We might try using add_custom_command instead which supposedly works with generator expressions.

dirk-thomas reviewed Mar 28, 2015
View reviewed changes

dirk-thomas removed their assignment Mar 31, 2015

dirk-thomas removed the in review Waiting for review (Kanban column) label Mar 31, 2015

dirk-thomas force-pushed the master branch 2 times, most recently from d9277b7 to 85924cc Compare April 10, 2015 20:06

clalancette added the enhancement New feature or request label Jul 14, 2017

dirk-thomas mentioned this pull request Sep 15, 2017

Implement Window 10 symlinks #109

Closed

hidmic mentioned this pull request Jul 23, 2021

Symlinking on Windows needs privilege #350

Open

clalancette added the backlog label Feb 3, 2022

audrow changed the base branch from master to rolling June 28, 2022 14:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add support for symlinked install on windows #6

add support for symlinked install on windows #6

dirk-thomas commented Mar 21, 2015

tfoote commented Mar 25, 2015

dirk-thomas commented Mar 25, 2015

wjwwood commented Mar 25, 2015

dirk-thomas commented Mar 25, 2015

wjwwood commented Mar 26, 2015

tfoote commented Mar 26, 2015

wjwwood commented Mar 26, 2015

wjwwood commented Mar 26, 2015

dirk-thomas Mar 28, 2015

wjwwood Mar 28, 2015

wjwwood commented Mar 31, 2015

mikaelarguedas commented Feb 22, 2018

dirk-thomas commented Feb 22, 2018

wjwwood commented Feb 22, 2018

mikaelarguedas commented Feb 22, 2018

hidmic commented Oct 16, 2020

dirk-thomas commented Oct 16, 2020

add support for symlinked install on windows #6

Are you sure you want to change the base?

add support for symlinked install on windows #6

Conversation

dirk-thomas commented Mar 21, 2015

tfoote commented Mar 25, 2015

dirk-thomas commented Mar 25, 2015

wjwwood commented Mar 25, 2015

dirk-thomas commented Mar 25, 2015

wjwwood commented Mar 26, 2015

tfoote commented Mar 26, 2015

wjwwood commented Mar 26, 2015

wjwwood commented Mar 26, 2015

dirk-thomas Mar 28, 2015

Choose a reason for hiding this comment

wjwwood Mar 28, 2015

Choose a reason for hiding this comment

wjwwood commented Mar 31, 2015

mikaelarguedas commented Feb 22, 2018

dirk-thomas commented Feb 22, 2018

wjwwood commented Feb 22, 2018

mikaelarguedas commented Feb 22, 2018

hidmic commented Oct 16, 2020

dirk-thomas commented Oct 16, 2020