-
-
Notifications
You must be signed in to change notification settings - Fork 12
feat: cli validate command #103
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import colors from 'colors'; | ||
| import { getSchemaFile, loadSchemaDocument } from './action-utils'; | ||
|
|
||
| type Options = { | ||
| schema?: string; | ||
| }; | ||
|
|
||
| /** | ||
| * CLI action for validating schema without generation | ||
| */ | ||
| export async function run(options: Options) { | ||
| const schemaFile = getSchemaFile(options.schema); | ||
|
|
||
| try { | ||
| await loadSchemaDocument(schemaFile); | ||
| console.log(colors.green('✓ Schema validation completed successfully.')); | ||
| } catch (error) { | ||
| console.error(colors.red('✗ Schema validation failed.')); | ||
| // Re-throw to maintain CLI exit code behavior | ||
| throw error; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| import fs from 'node:fs'; | ||
| import path from 'node:path'; | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { createProject, runCli } from './utils'; | ||
|
|
||
| const validModel = ` | ||
| model User { | ||
| id String @id @default(cuid()) | ||
| email String @unique | ||
| name String? | ||
| posts Post[] | ||
| } | ||
|
|
||
| model Post { | ||
| id String @id @default(cuid()) | ||
| title String | ||
| content String? | ||
| author User @relation(fields: [authorId], references: [id]) | ||
| authorId String | ||
| } | ||
| `; | ||
|
|
||
| const invalidModel = ` | ||
| model User { | ||
| id String @id @default(cuid()) | ||
| email String @unique | ||
| posts Post[] | ||
| } | ||
|
|
||
| model Post { | ||
| id String @id @default(cuid()) | ||
| title String | ||
| author User @relation(fields: [authorId], references: [id]) | ||
| // Missing authorId field - should cause validation error | ||
| } | ||
| `; | ||
|
|
||
| describe('CLI validate command test', () => { | ||
| it('should validate a valid schema successfully', () => { | ||
| const workDir = createProject(validModel); | ||
|
|
||
| // Should not throw an error | ||
| expect(() => runCli('validate', workDir)).not.toThrow(); | ||
| }); | ||
|
|
||
| it('should fail validation for invalid schema', () => { | ||
| const workDir = createProject(invalidModel); | ||
|
|
||
| // Should throw an error due to validation failure | ||
| expect(() => runCli('validate', workDir)).toThrow(); | ||
| }); | ||
|
|
||
| it('should respect custom schema location', () => { | ||
| const workDir = createProject(validModel); | ||
| fs.renameSync(path.join(workDir, 'zenstack/schema.zmodel'), path.join(workDir, 'zenstack/custom.zmodel')); | ||
|
|
||
| // Should not throw an error when using custom schema path | ||
| expect(() => runCli('validate --schema ./zenstack/custom.zmodel', workDir)).not.toThrow(); | ||
| }); | ||
|
|
||
| it('should fail when schema file does not exist', () => { | ||
| const workDir = createProject(validModel); | ||
|
|
||
| // Should throw an error when schema file doesn't exist | ||
| expect(() => runCli('validate --schema ./nonexistent.zmodel', workDir)).toThrow(); | ||
| }); | ||
|
|
||
| it('should respect package.json config', () => { | ||
| const workDir = createProject(validModel); | ||
| fs.mkdirSync(path.join(workDir, 'foo')); | ||
| fs.renameSync(path.join(workDir, 'zenstack/schema.zmodel'), path.join(workDir, 'foo/schema.zmodel')); | ||
| fs.rmdirSync(path.join(workDir, 'zenstack')); | ||
|
|
||
| const pkgJson = JSON.parse(fs.readFileSync(path.join(workDir, 'package.json'), 'utf8')); | ||
| pkgJson.zenstack = { | ||
| schema: './foo/schema.zmodel', | ||
| }; | ||
| fs.writeFileSync(path.join(workDir, 'package.json'), JSON.stringify(pkgJson, null, 2)); | ||
|
|
||
| // Should not throw an error when using package.json config | ||
| expect(() => runCli('validate', workDir)).not.toThrow(); | ||
| }); | ||
|
|
||
| it('should validate schema with syntax errors', () => { | ||
| const modelWithSyntaxError = ` | ||
| datasource db { | ||
| provider = "sqlite" | ||
| url = "file:./dev.db" | ||
| } | ||
|
|
||
| model User { | ||
| id String @id @default(cuid()) | ||
| email String @unique | ||
| // Missing closing brace - syntax error | ||
| `; | ||
| const workDir = createProject(modelWithSyntaxError, false); | ||
|
|
||
| // Should throw an error due to syntax error | ||
| expect(() => runCli('validate', workDir)).toThrow(); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.