Makefile won't work with a symlinked project

Question

Makefile won't work with a symlinked project

jmrodri opened this issue 7 years ago · comments

Jesus M. Rodriguez commented 7 years ago

I put all of my projects in $HOME/dev/some/path. For my golang projects I symlink the projects into my $GOPATH.

GOPATH=/home/jesusr/dev

mkdir -p $GOPATH/src/github.com/openshift/
pushd $HOME/dev
git clone git@github.com:jmrodri/open-service-broker-sdk.git
popd
pushd $GOPATH/src/github.com/openshift
ln -s $HOME/dev/open-service-broker-sdk .
popd

Now if you go into the symlinked directory and run make test you get an error:

pushd $GOPATH/src/github.com/openshift/open-service-broker-sdk
[jesusr@speed3 open-service-broker-sdk{master}]$ make test
glide install --strip-vendor --strip-vcs --update-vendored
[WARN]	The --update-vendored flag is deprecated. This now works by default.
[WARN]	The --strip-vcs flag is deprecated. This now works by default.
[WARN]	stat /home/jesusr/dev/open-service-broker-sdk/src: no such file or directory
[WARN]	stat /home/jesusr/dev/open-service-broker-sdk/vendor/src: no such file or directory
[ERROR]	Could not find any of /home/jesusr/dev/open-service-broker-sdk//src, /home/jesusr/dev/open-service-broker-sdk//vendor/src.
[INFO]	As of Glide 0.5/Go 1.5, this is required.
[ERROR]	Without src, cannot continue.
Makefile:142: recipe for target '.init' failed
make: *** [.init] Error 1

Looks like the ROOT tries to figure out where you are and that doesn't work with symlinks.

Paul Morie · Answer 1 · Fri May 05 2017 03:34:23 GMT+0800 (China Standard Time)

working on this now

Jesus M. Rodriguez · Answer 2 · Thu May 11 2017 00:40:11 GMT+0800 (China Standard Time)

The specific scenario under which I hit this issue does not yet work.

clone project to some directory
create a symlink to the project, locate the symlink in your GOPATH
attempt to build
fails

If I comment out the export GOPATH line in the Makefile everything works as I'd expect. I'm not sure if there are any other side effects of doing this though.

Jesus M. Rodriguez · Answer 3 · Thu May 11 2017 00:41:35 GMT+0800 (China Standard Time)

checkout code directly into GOPATH, WORKS
checkout code directly into GOPATH, create symlink FROM another dir, WORKS
checkout code outside GOPATH, create symlink IN GOPATH, FAILS

Eric Paris · Answer 4 · Thu May 11 2017 00:49:26 GMT+0800 (China Standard Time)

In general symlinks + golang == failure. There are long standing incompatibilities with golang and symlinks which are constantly closed by the golang core team with an explanation that golang does not support symlinks. Whenever anything comes along that works the golang core team's answer is "great that works, but it might not tomorrow, you must follow the golang way"

kubernetes and openshift try to make symlink hacks work when we know they can, but in general we will not invest time into making it work. After enough hits on the head it becomes apparent that if one can not change the golang core team the only option is to conform.

Jesus M. Rodriguez · Answer 5 · Thu May 11 2017 22:52:53 GMT+0800 (China Standard Time)

@eparis that's understandable. But if I comment out the export GOPATH defined in the Makefile all three of my scenarios work fine. If it's not something we plan to fix, then I can close and just live with it.

Jesus M. Rodriguez · Answer 6 · Thu May 11 2017 23:10:18 GMT+0800 (China Standard Time)

Fixed by PR #12

Ben Parees · Answer 7 · Wed May 17 2017 22:48:55 GMT+0800 (China Standard Time)

closing since this was fixed, but we still have a bad "getting started" experience since we now rely on the user having a valid GOPATH defined, as well as a proper directory structure.