Unit Testing

[jaidetree]

When working on #72 for advising, it became apparent how important testing would be to get that feature in a shippable state.

I drafted a basic unit testing suite to run fennel test files against the hs CLI. It's primitive, but still pretty useful for confirming functionality and behaviors.

Docs are included in ./docs/testing.org, with a basic recipe for auto-running tests

[Grazfather]

This is awesome.

[jaidetree]

Made a small change to move pprint into lib/globals.fnl instead of copying the impl twice in the testing/test-runner.fnl and core.fnl

[jaidetree]

@agzam Do you have a script to add the license\credits to each file or was that added manually?

[Grazfather]

A few nitpicks, looks great over all.

[Grazfather]

can be run

[Grazfather]

for extra clarity, something like: Before runs once before all it calls within a..

[Grazfather]

Maybe we should file tickets for these, and we can link.

[Grazfather]

We can turn this table into the shorthand : first version since you're touching it anyway.

[Grazfather]

hanging

[Grazfather]

Looks good. A few times you use is.eq instead of is.eq? in docs.

[Grazfather]

is.eq? vs is.eq

[agzam]

@agzam Do you have a script to add the license\credits to each file or was that added manually?

No, I don't have a script. Btw, would you like to discuss the licensing model, etc.? I think the file headers need a revamp. Maybe we should remove Author: Ag Ibragimov and should keep the list of contributors somewhere else? After so many additions and code modifications, that info in each file doesn't stay relevant for too long.

[agzam]

Great work @eccentric-j! This is quite nice. Now, what do you think, would it be very difficult to create a GitHub action and get them run before merging a PR?

[jaidetree]

Great work @eccentric-j! This is quite nice. Now, what do you think, would it be very difficult to create a GitHub action and get them run before merging a PR?

Thanks! @Grazfather asked a similar question the other day. That's definitely on my radar, touched on it a bit in #116.

Options to make this work include:

1. Having the container that the GH action use install OS X + Hammerspoon + Spacehammer and have it run tests similar to local
2. Mock the hs.* api and run the tests as a regular fennel script (currently it runs through the hs ipc API)

Option #1 is my first choice given that it would run the full tests against hs API which does change from time to time which would be the most accurate.

Option #2 would fix the performance issues, test consistency issues (at least during local development), and the state resetting issues (handled manually in the test definition using the before and after hooks to reset state) but it requires designing a mocking system, and maintaining consistent mocks with the required hs apis. This also means tests could become less accurate.

Thinking something similar to the jest mocking API I'm familiar with on the frontend

     ;; In a test
     (local mock mocking.spyOn(hs.window, 'focusWindowWest')
     (mocking.impl mock (fn [] nil)) ;; Create a spy that can take a mock impl
     (hs.window.focusWindowWest)
     (is.eq? (length mock.calls) 1 "Expected mock function to be called one time")

     ;; In a suite
     (after (fn [] (mocking.restore mock)))

Another option is something like clojure's with-redefs macro (or special form) that allows users to temporarily change a binding within a scope. While this would be cool and cover most of the use cases the mocking library above would, it doesn't work so well for async code.

[jaidetree]

@agzam Do you have a script to add the license\credits to each file or was that added manually?

No, I don't have a script. Btw, would you like to discuss the licensing model, etc.? I think the file headers need a revamp. Maybe we should remove Author: Ag Ibragimov and should keep the list of contributors somewhere else? After so many additions and code modifications, that info in each file doesn't stay relevant for too long.

I agree with moving author and contributors to a separate file perhaps so there's less to maintain there.

As for licensing what are your goals? Is it necessary to have the license in each file comments? Even the copyright year is already out of date.

We could setup something like https://typicode.github.io/husky/#/ with some standard pre-commit hooks that could automatically remove the header if there is one, then generate an up-to-date one on every commit. Might create some noise though once per-year when it updates though. Although personally I'm curious if there's a viable compromise that doesn't require comments in every file, but automating it would be my second choice and at least we could use the fennel CLI or babashka to update the files in a git hook script.

[agzam]

I'd rather have less "bureaucracy", even if it's conveniently semi-automated. Maybe let's remove the headers altogether, wdyt?

[jaidetree]

100% on board