Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI test to ensure that README.md files are present and correct #386

Merged
merged 6 commits into from
Nov 7, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ script:
- "sh ./_test/ensure-stubs-compile.sh"
- "sh ./_test/count-ignores.sh"
- "./bin/fetch-configlet"
- "sh ./_test/ensure-readmes-are-updated.sh"
- "./bin/configlet lint ."
sudo: false
rust:
Expand Down
36 changes: 36 additions & 0 deletions _test/ensure-readmes-are-updated.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
if [ ! -x bin/configlet ]; then
echo "Improper configuration; configlet should exist in bin/ when this script is run"
echo "Ping a Rust track maintainer to fix this"
exit 1
fi

newline=$'\n '

missing_readmes=""
wrong_readmes=""
for exercise in $(git diff --name-only master..$(git rev-parse --abbrev-ref HEAD) | grep exercises/ | cut -d'/' -f2 -s | sort -fu); do
echo "Checking readme for $exercise"
readme_path="exercises/${exercise}/README.md"
if [ ! -f $readme_path ]; then
missing_readmes="$missing_readmes$newline$exercise"
else
existing_readme_checksum=$(md5sum $readme_path | cut -d' ' -f1)
# generate the new README
bin/configlet generate . --only "$exercise"
generated_readme_checksum=$(md5sum $readme_path | cut -d' ' -f1)

if [ $existing_readme_checksum != $generated_readme_checksum ]; then
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

optional: I imagine you can check the exit code of diff rather than comparing the checksums against one another, if you find that easier.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't actually have both files in place at the same time; the configlet command to regenerate it overwrites the existing README.md, if any. For this reason, I thought it easier to just keep the md5sum in memory and compare that.

wrong_readmes="$wrong_readmes$newline$exercise"
fi
fi
done

if [ -n "$missing_readmes" ]; then
echo "Exercises missing README.md:$missing_readmes"
fi
if [ -n "$wrong_readmes" ]; then
echo "Exercises with out-of-date README.md:$wrong_readmes"
fi
if [ -n "$missing_readmes" -o -n "$wrong_readmes" ]; then
exit 1
fi