How to unit test a script? #442
Replies: 2 comments 4 replies
-
|
Inspirationally, I suppose I'm hoping to write tests that could look like this: describe("example.mjs", () => {
it("calls `ls` with expected args", async () => {
const stub = jest.fn()
somehowRunScriptUnderTest("./example.mjs", { shell: stub })
expect(stub).toHaveBeenCalledWith("ls -lha")
})
it("formats the output", async () => {
const result = somehowRunScriptUnderTest("./example.mjs", {
shell: jest.fn(() => `
Permissions Size User Date Modified Name
drwxr-xr-x - user 16 Jun 21:59 .
drwxr-xr-x - user 7 Jun 17:30 ..
drwxr-xr-x - user 16 Jun 21:59 foo
drwxr-xr-x - user 27 May 14:53 bar
`),
})
expect(result.stdout).toEqual(`
Permissions Size User Date Modified Name
drwxr-xr-x - user 16 Jun 21:59 .
drwxr-xr-x - user 7 Jun 17:30 ..
drwxr-xr-x - user 16 Jun 21:59 foo
drwxr-xr-x - user 27 May 14:53 bar
`)
})
})I'm no-doubt handwaving away important details in this pseudo-code, but just adding it here to explain my direction and intent with my question. I'm actually happy to pursue whatever approach zx supports and suggests. |
Beta Was this translation helpful? Give feedback.
-
|
You can use $.shell config for this. Override this function with a mock. |
Beta Was this translation helpful? Give feedback.
-
|
That sounds really promising @antonmedv! 🙏 Can you elaborate on how $.shell can be set to a mock? I know I can call a script ala As an example here's a uvu test that runs
import "zx/globals"
import * as assert from 'uvu/assert'
import sinon from "sinon"
import { suite } from 'uvu'
const test = suite("example.mjs")
test("formats the output", async () => {
const stub = sinon.stub(() => `
Permissions Size User Date Modified Name
drwxr-xr-x - user 16 Jun 21:59 .
drwxr-xr-x - user 7 Jun 17:30 ..
drwxr-xr-x - user 16 Jun 21:59 foo
drwxr-xr-x - user 27 May 14:53 bar
`)
const result = await $`zx --shell=${stub} example.mjs`
assert.equal(result.stdout, `
Permissions Size User Date Modified Name
drwxr-xr-x - user 16 Jun 21:59 .
drwxr-xr-x - user 7 Jun 17:30 ..
drwxr-xr-x - user 16 Jun 21:59 foo
drwxr-xr-x - user 27 May 14:53 bar
`)
})
test.run()This doesn't work because the stub object is passed into zx as a string, which of course doesn't respond properly. I'm sure I'm not understanding what you wrote, but can you elaborate how we may pass in the stub? |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
Hello. Sorry for the unhelpfulness / mundane-ness, so to speak. I just wanted to give you a kudos for this task. And just to share something (-...interesting, IMHO [lol]): guess how I found your (/this GH-) page? Voila--please see the attached pic. I was testing my cell-tower personal-hotspot-based connection in...(drumrolls)...land of Idi Amin, Uganda! 🤣
BUT...I am now really curious to know if and how you actually solved the problem! I guess I need to read on to find that out. Again, kudos! Respectfully, |
Beta Was this translation helpful? Give feedback.
-
@antonmedv, can you provide an example of how to do this? |
Beta Was this translation helpful? Give feedback.
-
Let's say we have this super simple script that just calls
ls:example.mjsHow may I test that this script actually calls
ls -lha? How can I test the output is rendered correctly?In the real world I'm looking to test various calls and logic like
git ...commands whose result are parsed and accumulated in various ways, but I think my question fundamentally boils down to how I can test anything at all. The bane of my existence has been effectively untestable Bash scripts, so I'm hoping to take a leap forward in maintainability with zx.Beta Was this translation helpful? Give feedback.
All reactions