Automated testing with Luacheck

[thomascft]

This is my fix for #527.
Well, I don't know git well enough clearly. I setup the testing, you can see the output here. I had a bit of cleanup, so that's what the force pushes were

[thomascft]

I should probably mention that the test rules are defined in .luacheckrc with the documentation over here.

[lcpz]

Thank you for this. However, we still need unit tests.

It's not so difficult now, we just need to create a test script with luaunit and run it in the Action you created, just after the linter call.

Feel free to continue to help me, I think it's a nice exercise for you.

Otherwise, I will work on it as soon as I can.

[lcpz]

For the next PR, you can add another job, say unit_tests, with a step in which you run the testing script.

[thomascft]

I'll try it out, should be able to get it in by Wednesday.

[thomascft]

Are you set on luaunit? Busted seems to have much better documentation, and the AwesomeWM team said it's what they use in #527. It would be nice to see how they've structured unit testing.

[lcpz]

Busted is fine. Take inspiration from AwesomeWM.

[thomascft]

What exactly do you need tested? I haven't done unit testing before and I'm not sure it's being done correctly.

[lcpz]

We need to launch an Awesome instance in which we load all the widgets (with all possible configurations) to see if they work. This test suite would be called to verify that each commit does not break anything.

I know this is a lot of work, but you can start by launching Awesome as mentioned here. Then, we can incrementally add tests.