Skip to content

[Tests] Remove filesystem mocks in doc fetch service tests #7908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gonzaloriestra wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −8
Draft

[Tests] Remove filesystem mocks in doc fetch service tests #7908

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions packages/cli/src/cli/services/commands/doc/fetch.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ import {describe, expect, test, vi, beforeEach} from 'vitest'
import {fetch} from '@shopify/cli-kit/node/http'
import {outputResult} from '@shopify/cli-kit/node/output'
import {AbortError} from '@shopify/cli-kit/node/error'
import {mkdir, writeFile} from '@shopify/cli-kit/node/fs'
import {dirname, resolvePath} from '@shopify/cli-kit/node/path'
import {inTemporaryDirectory, readFile, fileExistsSync} from '@shopify/cli-kit/node/fs'
import {joinPath} from '@shopify/cli-kit/node/path'

vi.mock('@shopify/cli-kit/node/http')
vi.mock('@shopify/cli-kit/node/output')
vi.mock('@shopify/cli-kit/node/fs')

const okResponse = (body: string) =>
({ok: true, status: 200, statusText: 'OK', text: () => Promise.resolve(body)}) as any
Expand Down Expand Up @@ -44,12 +43,18 @@ describe('docFetchService', () => {
})

test('writes the document to the output path instead of stdout', async () => {
await docFetchService('https://shopify.dev/docs/api/shopify-cli', 'docs/shopify-cli.md')
await inTemporaryDirectory(async (tmpDir) => {
// Given
const outputPath = joinPath(tmpDir, 'docs/shopify-cli.md')

const expectedPath = resolvePath('docs/shopify-cli.md')
expect(mkdir).toHaveBeenCalledWith(dirname(expectedPath))
expect(writeFile).toHaveBeenCalledWith(expectedPath, '# Doc')
expect(outputResult).not.toHaveBeenCalled()
// When
await docFetchService('https://shopify.dev/docs/api/shopify-cli', outputPath)

// Then
expect(fileExistsSync(outputPath)).toBe(true)
await expect(readFile(outputPath)).resolves.toBe('# Doc')
expect(outputResult).not.toHaveBeenCalled()
})
})

test('throws when the response is not ok', async () => {
Expand Down
Loading