From 7adcf729b90466906e3332f3bfeeee40034bd289 Mon Sep 17 00:00:00 2001
From: Jack O'Connor <oconnor663@gmail.com>
Date: Sat, 28 Jun 2014 13:45:52 -0700
Subject: [PATCH] create validate_third_party.sh and add it to .travis.yml

We would love to have peru fetch all of its own dependencies, but that
leads us to a bootstrapping problem: We can't run peru until it's
dependencies are present. To work around that, we define dependencies in
peru.yaml, and we also check them in. That means we could get into a
state where what's checked in doesn't match what's in peru.yaml, which
could cause all sorts of trouble.

To avoid that problem, create the validate_third_party.sh script. This
runs a fresh sync of our peru.yaml and compares the result to what we
have in the repo, to make sure they match. Run this as part of our
Travis tests. The expected workflow is that commits that change
peru.yaml should also commit the new third-party, or else they'll break
this test.

We're not including this in test.sh, because it's pretty slow if you
don't have PERU_PLUGINS_CACHE set to something persistent. Running it in
Travis should be enough.
---
 .travis.yml                     |  4 ++-
 scripts/validate_third_party.sh | 51 +++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+), 1 deletion(-)
 create mode 100755 scripts/validate_third_party.sh

diff --git a/.travis.yml b/.travis.yml
index 56ff169..a62d652 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -8,4 +8,6 @@ before_install:
 install:
   - sudo apt-get install -qq realpath
   - pip install flake8
-script: ./test.sh
+script:
+  - ./test.sh
+  - ./scripts/validate_third_party.sh
diff --git a/scripts/validate_third_party.sh b/scripts/validate_third_party.sh
new file mode 100755
index 0000000..9e7fd75
--- /dev/null
+++ b/scripts/validate_third_party.sh
@@ -0,0 +1,51 @@
+#! /usr/bin/env bash
+
+# Check the contents of third-party/ against what's specified in peru.yaml.
+#
+# We would love to have peru fetch all of its own dependencies, but that leads
+# us to a bootstrapping problem: We can't run peru until it's dependencies are
+# present. To work around that, we define dependencies in peru.yaml, and we
+# also check them in. That means we could get into a state where what's checked
+# in doesn't match what's in peru.yaml, which could cause all sorts of trouble.
+#
+# This test helps us avoid that problem. It runs a fresh sync of our peru.yaml
+# and compares the result to what we have in the repo, to make sure they match.
+# This runs as part of our Travis tests. The expected workflow is that commits
+# that change peru.yaml should also commit the new third-party, or else they'll
+# break this test.
+
+set -e
+
+repo_root=$(realpath $(dirname $BASH_SOURCE)/..)
+cd "$repo_root"
+
+mkdir -p /tmp/perutest
+found_dir=`mktemp -d --tmpdir=/tmp/perutest found.XXXXXX`
+expected_dir=`mktemp -d --tmpdir=/tmp/perutest expected.XXXXXX`
+
+# Only copy files not ignored by git into the found directory. This avoids
+# getting confused by *.pyc files and the like.
+echo Copying third-party to $found_dir
+# Handling filenames in a whitespace-safe way is extremely tricky.  See:
+# http://mywiki.wooledge.org/BashFAQ/020
+while IFS= read -r -d $'\0' file ; do
+  if [[ ! -e "$file" ]] ; then
+    continue  # Don't error out here on a removed file.
+  fi
+  mkdir -p "$found_dir/$(dirname "$file")"
+  cp "$file" "$found_dir/$file"
+done < <(git ls-files -z --cached --other --exclude-standard third-party)
+
+# Do a real peru sync in the expected directory.
+echo Syncing third-party to $expected_dir
+cp peru.yaml "$expected_dir"
+cd "$expected_dir"
+"$repo_root/peru.sh" sync
+# The peru.yaml file and the .peru dir won't be in the found dir, so get rid of
+# them here.
+rm -rf peru.yaml .peru
+
+# Compare the contents of expected and found. Errors out if there's a
+# difference.
+diff --recursive "$expected_dir" "$found_dir"
+echo SUCCESS: third-party/ and peru.yaml are in sync.