Handle test assets without submodules and extra setup

[uint]

This is part of the work for #176, but not all of it. It's just my proposal! We can scrap it if it doesn't work for you.

How it works

git-platinum is now kept as a tarball in data/git-platinum.tgz. All the necessary refs are in there already. There's a build.rs script that extracts the archive into data/git-platinum, which is ignored by git (git doesn't like nested repos, so we don't want to try checking it in).

Updating git-platinum

There's a script for that - scripts/update-git-platinum.sh. It will fetch the newest version of git-platinum, add the necessary refs, then update and commit the archive.

The big win

It should now be possible to simply git clone the repo and run cargo test without extra setup necessary, keeping it simple for future contributors. Also no more submodules.

Drawbacks

• 2 build dependencies added - flate2 and tar.
• The build script doesn't distinguish between test builds and other builds. It will unpack the archive even if we're not running any tests. Any errors there will stop the build.

[FintanH]

The build script doesn't distinguish between test builds and other builds. It will unpack the archive even if we're not running any tests. Any errors there will stop the build.

I thought we might have been able to use:

if cfg!(test) {
  unpack
  println!
}

But it seems like the build.rs file doesn't know about cargo test being run and so it never fires. Not a big deal anyway since it'll only run once unless the tar file is changed. If it fails the person won't be able to run the tests which would be bad anyway and they should report an issue.

[FintanH]

I'm in favour of this! What would the rest of the work look like? :)

[uint]

I'm in favour of this! What would the rest of the work look like? :)

Oh, I was referring to actually reorganizing the tests - as you wanted to in #176. No idea yet!

[uint]

Rebased and added sign-offs.

[FintanH]

Just a few things to clean up and then this is good to be merged :)

[FintanH]

We don't need this file anymore, right? We just use the same logic in the update script afaict. Would you mind removing this if that's the case?

[uint]

Yep, I meant to do that! Probably forgot. I'll add the change shortly.

[FintanH]

Maybe a safer thing to do here is checking if the directory exists and asking the person to remove it and exiting the script.

I'm worried that we'd remove a git-platinum by accident, e.g. we ran the script in the wrong directory 😅

[uint]

What if the whole script worked in some sort of .workdir and we added that one to .gitignore?

[FintanH]

#180 (comment) would be enough to resolve this I think :)

[uint]

I still created a sort of workdir. Feels cleaner anyway. How's that look?

[FintanH]

We could check that we're at the root by doing:

BASE=$(basename pwd)

if [ "${BASE}" -ne "radicle-surf" ]
then
   echo "this script should be run from the root of radicle-surf"
   exit 1
fi

Or something along those lines :)

[uint]

That's excellent. I'll give it a try. I was wondering if that's possible, but my bash powers are honestly fairly weak ;)

[FintanH]

Mine aren't much better, but I sure can google! :P

[FintanH]

Thanks for catching these :)

[FintanH]

Looks good! Just some small suggestions and then we're really ready to merge :)

[FintanH]

Merged via f238a45