Add travis-ci for sugardough reference project.

[glogiotatidis]

No description provided.

[glogiotatidis]

@magopian r?

[magopian]

So, from what I understand, it's running the tests from the "inner" template directory, right?
This is a good starting point, as at least we'll make sure the docs and tests from the template directory are correct, and that it's flake8 compliant.

Very good idea, but I have another one (not necessarily better though): how about the travis file here creates a project the way we document it, and then run the tests in it?

We could do that by creating a "test_sugardough.sh" script, launched from the .travis.yml file, which would look like the following (it needs the cookiecutter.json file to be changed to have another folder than sugardough which is already used):

pip install cookiecutter
cookiecutter --no-input .
cd sugardough_test
tox -e $TOX_ENV

This has the added benefit of making sure there's no issue with cookiecutter itself with our template.

Of course, travis could also run some more tests specific to the template itself, as explained in #12

Thoughts?

[glogiotatidis]

Agreed! Actually I commented exactly the same thing here #12 (comment)

I plan to add these tests as part of #16. Sounds good?

[magopian]

Yep!
Did you like the idea about generating the project in travis, and run the tests on it instead of using the --set-home -c parameters?

[glogiotatidis]

Actually i'll try to update this PR to generate the project and run tests as you say.

When we are done with this one I'll add project generation tests in #16.

brb

[glogiotatidis]

OK I added ./bin/test_sugardough.sh which creates a project and then runs tox against it. Locally I have no issues but on travis tests fail in a strange way. Maybe you have an idea what's going on?

[magopian]

I believe it's just because there's no test to be run, so coveralls fails (because there's no coverage file generated maybe?)

The flake8 errors are easy to fix I believe.

[glogiotatidis]

OK there's something strange going on that I cannot understand. When travis runs flake8 gives the following errors

sugardough/urls.py:10:2: W292 no newline at end of file
sugardough/settings/__init__.py:10:16: W292 no newline at end of file
sugardough/wsgi.py:32:65: W292 no newline at end of file
sugardough/settings/base.py:145:34: W292 no newline at end of file

All valid error because indeed those files don't have newlines at the end.

But those files in the reference project and in the cookiecutter template do have newlines at the end. Also if I run ./bin/test_sugardough.sh locally, I get no errors and files do have newlines at the end.

I don't know what's going on here. We can temporarily ignore W292 but we should figure out why cookiecutter generates different project in travis.

Can somebody cross check that these files have newlines in their local installs?

[coveralls]

Changes Unknown when pulling 9136b1f on glogiotatidis:travis into * on mozilla:master*.

[coveralls]

Changes Unknown when pulling 644b80b on glogiotatidis:travis into * on mozilla:master*.

[magopian]

That is odd... I don't have any errors on my test sugardough project: https://travis-ci.org/magopian/test_sugardough/jobs/43814764

When you say there is a newline, are you talking about the last character on a line, the \n, or an empty line? I'm asking because some editors automatically add (or remove) this last character.

[glogiotatidis]

The last \n is missing from these files. Check this output for more details. https://travis-ci.org/mozilla/sugardough/jobs/43823024#L341

(i do cat urls.py and you can see the result in line 340)

[magopian]

cookiecutter/cookiecutter#183 : what version of cookiecutter are we using on travis? Could that be the issue?

[magopian]

If we change https://github.com/mozilla/sugardough/pull/14/files#diff-354f30a63fb0907d4ad57269548329e3R10 to be cookiecutter==0.8.0, it should hopefully fix this issues ;)

[magopian]

btw, how about leaving cookiecutter unpinned? In the README, we tell people to pip install cookiecutter, so it would be nice to have travis use the latest version also.

I'd also leave tox unpinned really...

[glogiotatidis]

erm yes... and I did pin packages to be on the safe side. Thanks for solving the mystery @magopian. This is now working and ready for review.

[magopian]

FYI, I've used the shields.ioversions of the SVG in https://raw.githubusercontent.com/mozilla/sugardough/master/sugardough/README.md:

[![Build Status](https://img.shields.io/travis/mozilla/sugardough/master.svg)](https://travis-ci.org/mozilla/sugardough)
[![Coverage status](https://img.shields.io/coveralls/mozilla/sugardough/master.svg)](https://coveralls.io/r/mozilla/sugardough)

[glogiotatidis]

ok, changed both travis and requires.io

[magopian]

r+wc

[glogiotatidis]

Merci!