Tests for logger

[waynevanson]

#80 Tests for the logger.

I've used jest.resetModules() alongside beforeEach() and afterEach() to change process.env.NODE_ENV from "test" to "production", as logger[name] relies on NODE_ENV not to be in test mode.

Test coverage is 100% for this module.

Can I have someone check out these tests? I've never written tests like this before and am unsure what the standard.

I made the helper functions because I'll use them for the other log functions.

I extended this branch off a previous pull, which is why there is all this other stuff. I'll get rid of it later before opening up.

[sQVe]

I do not think it is a good idea to manipulate NODE_ENV.

If we refactor the individual methods in logger like this:

export const info = (msg: string) => {
  const text = chalk`{green.bold INFO:} ${msg}`;

  if (process.env.NODE_ENV !== "test") {
    console.log(text);
  }

  return text;
};

We could instead just test the return value easily, either manually or via a snapshot.

[waynevanson]

I like that a lot better! I'll add that in.

[waynevanson]

@sQVe If we are using NODE_ENV as a conditional, we can't test the case outside of test without changing it.

I think as long as we're mindful that we're changing it, it's okay. Otherwise we won't have the code coverage for it. All we'd be checking for is the colour of the text, which is half it's function.

What about something like this? It changes the env, calls the function then sets the previous environment back.

function useNodeEnv(
  env: "development" | "test" | "production",
  handler: () => void
) {
  const defaultEnv = process.env.NODE_ENV.toString();
  process.env.NODE_ENV = env;
  handler();
  process.env.NODE_ENV = defaultEnv;
}

useNodeEnv('production',() => {/* test in environment */})

[sQVe]

I think it is fine that the NODE_ENV === 'test' are not covered and can be excluded from coverage. If your going to mutate NODE_ENV that should be done in a beforeEach and afterEach with proper cleanup via jest.resetModules() or something similar.

[waynevanson]

Okay, I think I can do that after reading some stuff online. Thank you for the tips!

[sQVe]

Cleanup PR from moveFiles changes.

[codecov]

Codecov Report

Merging #93 into develop will increase coverage by 2.83%.
The diff coverage is 100%.

@@             Coverage Diff             @@
##           develop      #93      +/-   ##
===========================================
+ Coverage    90.99%   93.82%   +2.83%     
===========================================
  Files           18       19       +1     
  Lines          422      470      +48     
  Branches       106      114       +8     
===========================================
+ Hits           384      441      +57     
+ Misses          38       29       -9

Impacted Files	Coverage Δ
src/shared/logger.ts	100% <100%> (+50%)	⬆️
src/index/generateTrees.ts	100% <0%> (ø)	⬆️
src/index/shared/findImports.ts	90% <0%> (ø)	⬆️
src/index/generateTrees/printTree.ts	100% <0%> (ø)	⬆️
src/index/shared/detect-lonely-files.ts	100% <0%> (ø)
src/index/generateTrees/toFractalTree.ts	93.75% <0%> (+0.59%)	⬆️
src/index.ts	70.58% <0%> (+2.4%)	⬆️
src/index/generateTrees/buildGraph.ts	100% <0%> (+3.03%)	⬆️
src/index/formatFileStructure/moveFiles.ts	88.88% <0%> (+3.17%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d4305a...1bf4967. Read the comment docs.

[AnatoleLucet]

Some minor changes and we're good!

[AnatoleLucet]

Great, nice work! 🎉

[github-actions]

🎉 This PR is included in version 0.5.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀