Add codespell support

[daniellimws]

If applied, this commit will fix all spelling errors in the current
state of the repository. Furthermore, add a test in .travis.yaml to do
so on pull requests.

Based on Google Code-in task
https://codein.withgoogle.com/dashboard/task-instances/5347598271512576/

[kyrofa]

Careful, probably don't want to fix this one.

[daniellimws]

hmm right thanks for notifying

[sergiusens]

Hi there, thanks for your contribution. The current implementation is running codespell for every job. I think that moving the install stanza logic:

- sudo pip install codespell
- codespell -S "*.xz,*.zip,*.bz2,*.7z,*.gz,*.deb,*.rpm,*.snap,*.gpg,*.pyc,*.png,*.ico,*.jar,./.git" -w || true

to

    - stage: static
      if: type != cron
      script: sudo ./tools/travis/run_tests.sh static
    - if: type != cron
      script: sudo ./tools/travis/run_codespell.sh

And put your code in tools/travis/run_codespell.sh:

#!/bin/sh
sudo pip install codespell
codespell -S "*.xz,*.zip,*.bz2,*.7z,*.gz,*.deb,*.rpm,*.snap,*.gpg,*.pyc,*.png,*.ico,*.jar,./.git" -w || true

And make the script executable chmod +x tools/travis/run_codespell.sh

Does that sounds reasonable?

[sergiusens]

Ah, I forgot one thing, might want to add set -e so we don't have hidden errors.

[sergiusens]

the || true at the end of this will hide errors, I suggest we remove it.

[daniellimws]

okay

[daniellimws]

however the return value is the number of typos found, which will be non-zero and cause the build to fail

[sergiusens]

Making it 0 should be ideal 😄
If we don't make it fail, then we will never detect any new issues.

[daniellimws]

As seen here https://travis-ci.org/snapcore/snapcraft/jobs/308985647, the build fails because codespell returns the number of typos found.

[sergiusens]

a dash (-) is missing here, as a block it should look like:

     - stage: static
       if: type != cron
       script: sudo ./tools/travis/run_tests.sh static
     - if: type != cron
       script: sudo ./tools/travis/run_codespell.sh

[sergiusens]

the -w should be removed here

[daniellimws]

Oh sorry I misunderstood the task.

[sergiusens]

I would fix './snapcraft/tests/integration/snaps/waf-with-configflags/shlib/test_shlib.c' and change 'gonna' to 'going to'
And exclude debian/changelog from the default checks due to that purposeful typo added.

[sergiusens]

I've been looking at the help and we want to add -q 4 to this line

[daniellimws]

What about the "iff"?

[sergiusens]

iff is not required due to the -q 4 argument

[sergiusens]

Here's the progression

(snapcraft) ubuntu@snapcraft-dev:~/source/snapcraft$ 
(snapcraft) ubuntu@snapcraft-dev:~/source/snapcraft$ codespell -S "*.xz,*.zip,*.bz2,*.7z,*.gz,*.deb,*.rpm,*.snap,*.gpg,*.pyc,*.png,*.ico,*.jar,./.git" 
./debian/changelog:54: ocurred  ==> occurred
./snapcraft/tests/integration/snaps/waf-with-configflags/shlib/test_shlib.c:5: gonna  ==> going to  | disabled because one might want to allow informal spelling
./snapcraft/tests/integration/general/test_empty_dir.py:31: nTo  ==> not  | disable due to \n
./snapcraft/tests/unit/plugins/test_catkin.py:478: iff  ==> if  | disabled due to valid mathematical concept
(snapcraft) ubuntu@snapcraft-dev:~/source/snapcraft$ codespell -S "*.xz,*.zip,*.bz2,*.7z,*.gz,*.deb,*.rpm,*.snap,*.gpg,*.pyc,*.png,*.ico,*.jar,./.git" -q 4
./debian/changelog:54: ocurred  ==> occurred
(snapcraft) ubuntu@snapcraft-dev:~/source/snapcraft$ codespell -S "*.xz,*.zip,*.bz2,*.7z,*.gz,*.deb,*.rpm,*.snap,*.gpg,*.pyc,*.png,*.ico,*.jar,./.git,changelog" -q 4
(snapcraft) ubuntu@snapcraft-dev:~/source/snapcraft$ 

[daniellimws]

Oh no, I misread and removed the typo instead of excluding debian/changelog

[sergiusens]

Great, the first step passed so it should most likely end up being green. I am approving this and will merge given the travis run ends up being green

[kyrofa]

I want to take the opportunity to call out your commit messages, here: they are outstanding. I love how they're phrased as commands. Since GCI is a learning experience, I have a single suggestion to improve further: the commit messages should complete the sentence "If applied, this commit will ", not actually include the phrase "If applied, this commit will". So for example, your first commit would be "Fix all spelling errors in the current [...]".

Wonderful job, keep up the good work.

[daniellimws]

Ah haha I may have misunderstood that statement. Thanks a lot.