Fix GitHub Package Tests

[wadethestealth]

Description of the Change

• Removes state leak from previous tests.
• Refactors layout/structure of test to reflect BDD best pratices (For good examples, see Better Specs) Note: we prefer describe in place of context.
• All test functions remain testing the exact same properties.

Benefits

• Remove state leak.
• Fix flakes
• Cleaner test assertion and test description

Possible Drawbacks

This will slow down test, because we were previously not preventing state leak.

Applicable Issues

#2308 Ran into trouble implementing good test cases, because state leak was corrupting the results.

Metrics

• All tests passing without retries.

Tests

I fixed 'em 😉

Release Notes

Updated test case accuracy.

[smashwilson]

Major kudos for taking this on 🙌 Bringing old and unwieldy test suites up to date is pretty thankless work, and I really appreciate it. It's looking much better and I see it'll fix a bunch of longstanding flakes along the way.

How are we doing on test coverage so far? This is one of the suites that didn't have great test coverage in the past (and that's even more of a pain to bring up to date after the fact 😅 ). You can check it out locally by running npm run test:coverage and loading the .lcov file with a package like atom-lcov.

I see you've still got the last commented-out bit left to do - re-request review from me when you're ready and we'll get this in 😄

[wadethestealth]

How are we doing on test coverage so far?

It doesn't seem super awful. I have not covered any new branches though, as I was just updating the old code.
Things I have noticed:

• Any outside api you are consuming (eg. status bar) is not being covered.
• A couple of branches are only being tested with one conditional outcome.
• Serialization is not tested.
• Yardstick setup is basically untested.
• A couple of nested function/properties that are functions are not being covered.

Also, the failed test case was not me it was a flake.

[smashwilson]

✨