[48h Knative] Command Usage Example Integration Testing POC

[Cali0707]

👋 Hello awesome contributor!

Are you excited about Knative and open-source development? You're in the right place! This is a mini-project for the upcoming 48h Knative event—a 48-hour hackathon designed to boost contributions to the Knative Client project. For more details, check out Issue #1842.

🎯 Project Description

The Knative client has a help flag on it's commands that often prints example usages to the console. For example, the output of kn broker create --help will include multiple examples for how to create a broker with kn.

Unfortunately, these examples are not tested to always work, so there can be bugs where the example command no longer works (e.g. https://github.com/knative/client/issues/1885).

There is an open issue to implement integration tests for all examples (https://github.com/knative/client/issues/1889), and it has some initial thoughts on an approach. However, the extent of this project is to create a proof of concept implementation of how we can test all of the examples, by adding tests for the examples for one command.

🌟 Benefits

Often, the help text is how users learn how to us the knative client, so we should ensure that it is always up to date and working. This will ensure that it always is.

🛠 Difficulty Level

Intermediate

👥 Recommended Team Size

1-3 people

🎉 Expected Outcome

A proof of concept where all of the examples for one command have integration tests. This POC should work in a way where adding new examples to the command would require that those new examples have integration tests.

🤝 Mentor

@Cali0707

📝 Additional Information

🌐 Entrypoints

---

📋 Organizer Checklist

• [x] Added to Project Board
• [x] Proposal Reviewed
• [x] Assigned a Mentor
• [x] Expected Outcome define

[rhuss]

oops, just realized that we forgot to pick up that story in the 48h Knative Hackathon last December. Sorry for that, I still think this is a good story to implement.

[github-actions[bot]]

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

[rhuss]

/remove-lifecycle stale

[github-actions[bot]]

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.