Add test-sos as a submodule

[kholland-intel]

No description provided.

[davidozog]

Let's add --recursive-submodule to the example build scripts.

[davidozog]

Looks good! Suggest adding a comment in the RPM build in CI.

[wrrobin]

I did not try it out, but do we have to use recurse-submodule now every time? Do we need any update on our README or wiki pages?

[davidozog]

I did not try it out, but do we have to use recurse-submodule now every time? Do we need any update on our README or wiki pages?

Yes, if you want to build SOS successfully you will now need to call git clone --recurse-submodules <SOS> to clone both SOS and the tests-sos submodule. You could alternatively clone normally (i.e. without --recurse-submodules) then run git submodule update --init from inside the repo before running autogen.sh.

I think we should also consider a feature where SOS can be built without having to clone and build the tests, but that is not supported in this PR. Do you think we should do that before merging this change?

I absolutely think we should document everything before merging. Also please note my comment above about testing any PR that changes both SOS and the tests-sos submodule... This procedure could be confusing without documentation.

[wrrobin]

@davidozog - I was trying this branch out and the submodule download always getting stuck for me. Not sure if the issue is related with git config. Did you see this?

$> git clone -b "pr/test-submodule" --recurse-submodules https://github.com/kholland-intel/SOS.git sos-submodule
Cloning into 'sos-submodule'...
remote: Enumerating objects: 17958, done.
remote: Counting objects: 100% (1362/1362), done.
remote: Compressing objects: 100% (499/499), done.
remote: Total 17958 (delta 930), reused 1162 (delta 825), pack-reused 16596
Receiving objects: 100% (17958/17958), 5.33 MiB | 18.31 MiB/s, done.
Resolving deltas: 100% (13463/13463), done.
Updating files: 100% (1806/1806), done.
Submodule 'modules/tests-sos' ([email protected]:openshmem-org/tests-sos.git) registered for path 'modules/tests-sos'
Cloning into '/mnt/scratch/rahmanmd/sos-submodule/modules/tests-sos'...

Quick google search led to https://stackoverflow.com/questions/40841882/automatically-access-git-submodules-via-ssh-or-https/44630028#44630028 which suggests to use relative path for submodules. Not sure if that is the fix.

[davidozog]

@wrrobin @philipmarshall21 - It seems like we're spending too much time waiting on the UCX with pmi-mpi test row. I propose we remove it or swap it out with something else until #1048 is resolved.

Is the UCX with pmi-mpi test case important to anybody listening? @jdinan perhaps? It's not needed on our end...

[wrrobin]

@davidozog - The changes resolved the issue of make check.

PR is now assigned to me, so dismissing my review from earlier

[wrrobin]

Tested with different build directories. Works perfectly.

[davidozog]

Tested with different build directories. Works perfectly.

This reminds me we need CI to cover the case of users building in the SOS root directory - added issue #1111 so we can merge this asap since it's holding up other PRs.