feat: added testing for new

[Samridhi-98]

Description

• Added new.test.ts

Todo

• Add startStudio.test.ts

Related issue(s)

Fixes #106

[github-actions]

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[Samridhi-98]

@fmvilas please review my PR 🙂

[fmvilas]

Adding @Souvikns as I'm not a maintainer of this repo :)

[Souvikns]

@Samridhi-98 firstly thanks for opening PR we really appreciate it 👍🏻

The new command generates specification files. It is using inquirer to prompt for inputs. In the test environment, it is waiting for prompt input but not getting it. Due to this, you see the timeout exceeded error. Let me know if this makes sense.

Here you have to test for stdin and you can check out https://stackoverflow.com/questions/56797392/oclif-prompt-testing for some idea.

[Samridhi-98]

@Souvikns I have implemented the changes but still getting a bunch of errors, Also I have doubts related to @oclif/test will you please provide me some resources. 🙂

[Souvikns]

The issue you see is because of the prompt testing, I tried finding some examples with inquirer but wasn't able to find anything.

I tried running the test in uninteractive mode it works fine

describe('new', () => {
    test
        .stderr()
        .stdout()
        .do(() => {
            testHelper.createAsyncapiFile('specification.yaml', 'default-example.yaml');
        })
        .command(['new', '--no-tty', '-n=specification.yaml'])
        .it('runs new command', ctx => {
            expect(ctx.stdout).to.contain('specification.yaml');
        });
});

only you can make sure that specification.yaml does not exist when you are running the test.
I am still trying to figure out how the prompt testing works and I will let you know when I get something.

[Souvikns]

Wow this is interesting, the tests are running in my local dev environment, but looking into the logs I think it is not waiting for the command to finish and thus is failing and some times it is causing problem for other tests as well.

 runs new command:
     AssertionError: expected '' to include 'specification.yaml'
      at Context.<anonymous> (test/commands/new.test.ts:9:29)
      at Object.run (node_modules/fancy-test/lib/base.js:44:38)
      at Context.run (node_modules/fancy-test/lib/base.js:68:36)

[Souvikns]

The test is flaky, sometimes it is running, and sometimes not.

[Souvikns]

Suggested change

	expect(ctx.stdout).to.contain('specification.yaml');
	expect(ctx.stderr).to.equals('');
	expect(ctx.stdout).contains('specification.yaml');

This is working for me, you can try this once.

[Samridhi-98]

Still showing error 😟😟

[Souvikns]

Try what I suggested once, and if it does not work let me know I will open a PR to your branch 👍🏻

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[Souvikns]

Looks good to me, I think it is ready to be merged 🚀

[Souvikns]

/rtm

[derberg]

@all-contributors please add @Samridhi-98 for tests

[allcontributors]

@derberg

I've put up a pull request to add @Samridhi-98! 🎉

[asyncapi-bot]

🎉 This PR is included in version 0.15.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀