tcdownload: returns 1 if 'No complete TaskCluster runs found for ref'

[psaavedra]

Typically in UNIX like systems, every command returns an exit semantic status (sometimes referred to as a return status or exit code). A successful command returns a 0, while an unsuccessful one returns a non-zero value that usually can be interpreted as an error code. I propose a small change in the script to return 1 in 'No complete TaskCluster runs found for ref' situations.

[foolip]

I don't know where tcdownload.py is used, so @jgraham should probably review.

[foolip]

Isn't sys.exit(run(None, vars(kwargs))) or similar needed below for this to work?

[psaavedra]

The result of the run() function for tc-download is captured by wpt in

wpt/tools/wpt/wpt.py

Line 166 in 5336ed0

sys.exit(int(rv))

)

Actually, the tc-download is a subcommand of wpt. Example:

./wpt tc-download --ref a7f3642cf9af7321211ac05cd06e0512fb4d6372  ...

[psaavedra]

BTW @clopez has an interesting extension for this which we are using to get results from task-cluster and upload it the wpt.fyi repository: psaavedra@c093e31

[foolip]

Thanks, then I understand the context. Writing a longish explanation in the commit message is OK and helpful in review.

[jugglinmike]

It's a sub-commant for the WPT CLI:

$ ./wpt tc-download --help
usage: wpt tc-download [-h] [--ref REF] [--artifact-name ARTIFACT_NAME]
                       [--repo-name REPO_NAME] [--token-file TOKEN_FILE]
                       [--out-dir OUT_DIR]

optional arguments:
  -h, --help            show this help message and exit
  --ref REF             Branch (in the GitHub repository) or commit to fetch
                        logs for
  --artifact-name ARTIFACT_NAME
                        Log type to fetch
  --repo-name REPO_NAME
                        GitHub repo name in the format owner/repo. This must
                        be the repo from which the TaskCluster run was
                        scheduled (for PRs this is the repo into which the PR
                        would merge)
  --token-file TOKEN_FILE
                        File containing GitHub token
  --out-dir OUT_DIR     Path to save the logfiles

[foolip]

What uses ./wpt tc-download? I guessed wpt.fyi but that's not it, so maybe Gecko CI?

[jgraham]

I don't know that any part of our automation is currently using this. That doesn't mean it's not useful of course.