Closed Bug 1597352 Opened 5 years ago Closed 4 months ago

Integrate taskcluster.yml validation into the Quickstart tool

Categories

(Taskcluster :: General, enhancement)

Product:
Taskcluster
Component:
General
Type:
enhancement
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: dustin, Unassigned)

References

Details

The quickstart tool is currently useful for generating a simple .taskcluster.yml for a GitHub repository to integrate with the Taskcluster-GitHub service.

However, a common issue for users is testing subsequent changes to .taskcluster.yml. It's easy to use incorrect JSON-e syntax and generate something bogus. Testing is generally accomplished my making changes and pushing them to a PR, but this is a very "public" kind of testing as everyone subscribed to the repository sees all of those "oops, had a typo" pushes. It also only tests pull-request functionality -- testing pushes, tags, or releases is much more difficult.

Marco has created https://github.com/marco-c/taskcluster_yml_validator as a command-line tool for validating .taskcluster.yml's, by rendering them against a collection of possible GitHub events.

It would be great to combine this functionality into the Quickstart tool, such that users can do something like this:

  • Enter their owner/repo name
  • Click a button to load .taskcluster.yml from that repo into the browser
  • Select from a menu of recent events on the repository
  • Click "Test" and see the resulting generated tasks, as well as any validation errors for those tasks
Depends on: 1568938

Note: this bug depends on 1568938; however, the assignee can familiarize themselves with the library and try it out and get it working on their machine even before 1568938 is completed. I tried to use the library while working on 1568938, but it proved far less trivial than just making test PRs in the github_testing repo.....

The second thing would probably be to add an api layer to the thing, which will be needed to power the button - functional QuickStart isn't required for this as well, as curl or Postman could be used for functional testing.

(I am actually not sure QuickStart needs to work for this, as the button seems independent of the rest of the page's functionality?)

Hi Dustin,
I'm new to this and would like to work on this if this is still available, as I see it was opened 2 years ago.

I was able to setup the UI development environment, made a small PR #5009,
ii'd be great if you could help me on how to start on this issue.

Flags: needinfo?(djmitche)

Hi Rahul!

That was smart to ask :)

I think this was more of a "project" bug, that needed some more design before being implemented. I think it's still a good idea, but I don't know if anyone is around to help with or guide that design process. Personally, I don't work on Taskcluster anymore and I've forgotten a lot of the context that might be required for this bug.

So -- maybe this isn't a good one to start with..

Flags: needinfo?(djmitche)

Got it!
Thanks for the update, will look for some other tasks to start with.

I think we can close this for now, as there was similar too introduced that can test taskcluster.yml against various events and payloads - https://community-tc.services.mozilla.com/tcyaml-debug

Status: NEW → RESOLVED
Closed: 4 months ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.