test: rename snapshot.test.js to integration.test.js and add testcases by Adi-204 · Pull Request #1415 · asyncapi/generator

Adi-204 · 2025-03-15T04:38:11Z

Description

Rename snapshot.test.js to integration.test.js
Added testcases regarding missing params
a. without clientFileName param
b. without server param

Related issue(s)
Fixes: #1414

Summary by CodeRabbit

Tests
- Added new test cases to enhance validations for client generation scenarios, ensuring default file naming is correctly applied.
- Verified that missing essential configuration triggers clear error messaging for a smoother user experience.

changeset-bot · 2025-03-15T04:38:15Z

⚠️ No Changeset found

Latest commit: 520bcfe

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2025-03-15T04:38:19Z

Walkthrough

The pull request enhances the test suite for client generation from templates by introducing two new test cases. One test verifies that generating a "hoppscotch echo" client without a specified clientFileName uses the default output file. The second test checks that an error is thrown when the required server parameter is missing. The overall structure of the test suite remains unchanged, and there are no modifications to any public APIs or exported entities.

Changes

File(s)	Summary
packages/templates/clients/js/websocket/test/integration.test.js	Added a test case to verify default output file generation for "hoppscotch echo" when `clientFileName` is omitted, and another test case to confirm error handling when the `server` parameter is not provided.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test
    participant CG as Client Generator
    participant FS as File System

    T->>CG: Request client generation for "hoppscotch echo" without clientFileName
    CG->>CG: Determine default output file
    CG->>FS: Generate client file using the default name
    FS-->>CG: Confirm file creation
    CG-->>T: Return generated client matching snapshot

sequenceDiagram
    participant T as Test
    participant CG as Client Generator

    T->>CG: Request client generation for "hoppscotch echo" without server parameter
    CG-->>T: Throw error "Parameter missing: server"

Suggested labels

ready-to-merge

Suggested reviewers

jonaslagoni
magicmatatjahu
asyncapi-bot-eve
derberg

Poem

I'm a bunny with a code so fine,
Hopping through tests in a joyful line.
Defaults spring into action with a gentle leap,
Errors get caught before they creep.
In the garden of code, my changes bloom bright!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
- To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f572c32 and 520bcfe.

📒 Files selected for processing (1)

packages/templates/clients/js/websocket/test/integration.test.js (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/templates/clients/js/websocket/test/integration.test.js

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Test generator as dependency with Node 20
GitHub Check: Test generator as dependency with Node 18
GitHub Check: Test NodeJS PR - windows-latest

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
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/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

derberg · 2025-03-15T16:41:13Z

+    expect(clientOutputFile).toBeDefined();
+
+    const client = await readFile(clientOutputFile, 'utf8');
+    expect(client).toMatchSnapshot();


no need to do snapshot there

you check only one thing here: if output client name is client.js

so instead of expecting snapshot match - you should just validate if file client.js exists

@derberg thanks for the guidance : ) Changes done please check.

sonarqubecloud · 2025-03-16T04:25:39Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

derberg · 2025-03-17T11:09:53Z

/rtm

test: rename snapshot.test.js to integration.test.js and add testcases

aa5849a

Adi-204 requested review from asyncapi-bot-eve, derberg, jonaslagoni and magicmatatjahu as code owners March 15, 2025 04:38

Adi-204 added 3 commits March 15, 2025 10:22

chore: update snapshot

421f83b

chore: code cleanup

19cb069

chore: correct the asyncapi-path of without server param

c3804c4

derberg reviewed Mar 15, 2025

View reviewed changes

chore: removed snapshot testing in testcase without clientFilename param

f572c32

Adi-204 requested a review from derberg March 15, 2025 17:08

derberg reviewed Mar 15, 2025

View reviewed changes

Comment thread packages/templates/clients/js/websocket/test/integration.test.js Outdated

chore: added async method stat to check file exists

520bcfe

Adi-204 requested a review from derberg March 16, 2025 13:45

derberg approved these changes Mar 17, 2025

View reviewed changes

asyncapi-bot added the ready-to-merge label Mar 17, 2025

asyncapi-bot merged commit 17072fd into asyncapi:master Mar 17, 2025

This was referenced Apr 15, 2025

chore: adopted new file structure and update README and example.js with postmanClient and hoppscotchClient. #1476

Closed

chore: update Postman client example in python folder. #1498

Merged

coderabbitai Bot mentioned this pull request Jun 11, 2025

refactor: new file structure in js websocket client #1609

Merged

coderabbitai Bot mentioned this pull request Jun 30, 2025

test: remove code duplication of integration.test.js #1630

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

test: rename snapshot.test.js to integration.test.js and add testcases#1415

test: rename snapshot.test.js to integration.test.js and add testcases#1415
asyncapi-bot merged 6 commits into
asyncapi:masterfrom
Adi-204:integration-test

Adi-204 commented Mar 15, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Mar 15, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented Mar 15, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

derberg Mar 15, 2025

Uh oh!

Adi-204 Mar 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

sonarqubecloud Bot commented Mar 16, 2025

Uh oh!

derberg commented Mar 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

Adi-204 commented Mar 15, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai Bot commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

derberg Mar 15, 2025

Choose a reason for hiding this comment

Uh oh!

Adi-204 Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud Bot commented Mar 16, 2025

Quality Gate passed

Uh oh!

derberg commented Mar 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Adi-204 commented Mar 15, 2025 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Mar 15, 2025 •

edited

Loading

coderabbitai Bot commented Mar 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

Adi-204 Mar 15, 2025 •

edited

Loading