Add k6 new subcommand

[andrewslotin]

What?

This PR adds a new subcommand to k6 that creates a new test script file and populates it with a sample script similar to the one in Grafana Cloud k6 script editor.

Why?

This subcommand reduces the amount of boilerplate code required to author a new script. Sample code provides new k6 users with instructions on how to run this test in Grafana Cloud and/or enable Browser API by pointing them to appropriate places in documentation.

Checklist

• I have performed a self-review of my code.
• I have added tests for my changes.
• I have run linter locally (make ci-like-lint) and all checks pass.
• I have run tests locally (make tests) and all tests pass.
• I have commented on my code, particularly in hard-to-understand areas.

Related PR(s)/Issue(s)

Closes #3294

[codecov-commenter]

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Comparison is base (0ff7078) 73.30% compared to head (f389ed3) 73.35%.

❗ Current head f389ed3 differs from pull request most recent head 28c3403. Consider uploading reports for the commit 28c3403 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3394      +/-   ##
==========================================
+ Coverage   73.30%   73.35%   +0.05%     
==========================================
  Files         260      261       +1     
  Lines       19687    19739      +52     
==========================================
+ Hits        14432    14480      +48     
  Misses       4365     4365              
- Partials      890      894       +4     

Flag	Coverage Δ
ubuntu	73.28% <88.67%> (+0.04%)	⬆️
windows	73.19% <88.67%> (+0.04%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
cmd/root.go	94.00% <100.00%> (ø)
cmd/new.go	88.46% <88.46%> (ø)

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[codebien]

Hey @andrewslotin,
thanks for addressing it 🙇

[codebien]

@mstoykov @olegbespalov Adding you so you are aware of it, as I know there are different opinions on this command.

[olegbespalov]

Looks good. I left a few minor comments and one suggestion 👍

[codebien]

I'm fine with most of the changes as I commented before I would prefer if we not include here the Cloud suggestion with the old option.

[na--]

Hey, spotted this by chance when I was skimming notification emails, and I was immediately confused by the PR title, specifically about what is being initialized by k6 init 😅 Considering we have an "init context" in the test lifecycle, I thought it had something to do with that or even #785 😅

My 2c: having such a sub-command to is probably a good idea. Though I very rarely make use of such commands in other tools, I know other people find them useful. However, the k6 init sub-command might be somewhat confusing because we already have other things that we call "init". k6 create or k6 new or something like that seems less likely to be confusing.

[andrewslotin]

I like the idea of k6 new! Indeed, while init seems to be widely adopted by other tools, it may convey false assumption that it can be used only once per project, while the idea is to have it a standard way to create a new script.

@olegbespalov, @codebien, what are your thoughts on this? I’d be up for making necessary renamings.

[codebien]

what are your thoughts on this?

I don't have a strong opinion here, k6 new has the benefit of being shorter so I am fine with it.

[andrewslotin]

Renamed k6 init to k6 new as per discussion above. @oleiade, @codebien, PTAL at the last commits. There are no other changes apart from renaming the file and replacing init with new where appropriate.

[andrewslotin]

OK, there is one more edit: I've replaced the link to k6.io/docs with Grafana docs ones, since we're migrating our documentation there.

[olegbespalov]

I don't have a strong opinion about the init vs. new.

[codebien]

I'm quite happy with the final solution. Thanks for the effort. 🙇 @andrewslotin

[oleiade]

🚀 🚀 🚀