chore: set up ZENSTACK_TEST environment variable during test setup

[ymc9]

Summary by CodeRabbit

• Tests
  • Updated Jest configuration to enhance test setup.
  • Added environment setup for tests to ensure consistent test environments.
  • Improved test scaffolding reliability by refining package-lock.json file detection.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates involve modifications to the Jest configuration and test environment setup. The jest.config.ts file now points to new locations for its globalSetup and setupFiles scripts, with an additional setup file added to configure the test environment. Two scripts, set-test-env.ts and test-global-setup.ts, have been introduced or altered to adjust environment variables and path checks for a package-lock.json file, enhancing the test scaffolding process.

Changes

File	Change Summary
jest.config.ts	Updated paths for globalSetup and setupFiles, added new setupFiles entry
script/.../set-test-env.ts	Added to set ZENSTACK_TEST environment variable to '1'
script/.../test-global-setup.ts	Updated file path check for package-lock.json in test scaffold directory

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between da53753 and a8899fa.

Files ignored due to path filters (8)

• package.json is excluded by: !**/*.json
• packages/plugins/openapi/package.json is excluded by: !**/*.json
• packages/plugins/swr/package.json is excluded by: !**/*.json
• packages/plugins/tanstack-query/package.json is excluded by: !**/*.json
• packages/plugins/trpc/package.json is excluded by: !**/*.json
• packages/schema/package.json is excluded by: !**/*.json
• packages/server/package.json is excluded by: !**/*.json
• tests/integration/package.json is excluded by: !**/*.json

Files selected for processing (3)

• jest.config.ts (1 hunks)
• script/set-test-env.ts (1 hunks)
• script/test-global-setup.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• script/set-test-env.ts

Additional comments: 3

script/test-global-setup.ts (1)

• 5-5: The update to the file path for checking the existence of the package-lock.json file is a critical change for ensuring the script verifies the correct location. Please ensure that the new directory structure (.test/scaffold) accurately reflects the intended organization for test scaffolds within the project.

jest.config.ts (2)

• 12-12: The update to the globalSetup path is crucial for ensuring Jest uses the correct script for global setup before tests are run. This change appears to correctly point to the updated location of the test-global-setup.ts script. Ensure that the path accurately reflects the script's location within the project structure.
• 14-14: The addition of a new entry in setupFiles to include set-test-env.ts is a significant enhancement for setting up the test environment. This change effectively ensures that the ZENSTACK_TEST environment variable is set before any tests are executed, which is essential for isolating test executions. Please verify that this script is correctly placed and functions as intended within the test setup process.

[ymc9]

Closes #1020