[load] az load test create should not required field test-id in CLI when set in yaml configuration file.

[azclibot]

Source: Azure/azure-cli#32170 (by vlahane)
Affected extension: load (src/load/)

---

<<UNTRUSTED:issue-32170>>

Issue #32170 (by vlahane)

Title

az load test create should not required field test-id in CLI when set in yaml configuration file.

Body

Describe the bug

Even if a required field is present in the configuration file, the CLI should not prompt for it as a required input.

testId: demosimpleloatst

but current it throws error:
the following arguments are required: --test-id/-t

Related command

z load test create --load-test-resource $LOAD_TEST_RESOURCE -g $LOAD_TEST_RESOURCE_GROUP --load-test-config-file test.yaml --autostop disable

Errors

the following arguments are required: --test-id/-t

Issue script & Debug output

''' yaml
version: v0.1
testId: demosimpleloatst
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
configurationFiles:

• 'sampledata.csv'
• 'testfragment.jmx'
  zipArtifacts:
• bigdata.zip
  '''

Expected behavior

when Load test configuration has ''' testId''' value mentioned then cli should ask for testId in command line or we should remove it from config file

Environment Summary

az --version
azure-cli 2.76.0 *

core 2.76.0 *
telemetry 1.1.0

Extensions:
load 2.1.0
ml 2.38.0
ssh 2.0.6

Dependencies:
msal 1.33.0b1
azure-mgmt-resource 23.3.0

Additional context

No response

Comments

Comment by @azure-client-tools-bot-prd[bot]

Hi vlahane,

2.76.0 is not the latest Azure CLI(2.77.0).

If you haven't already attempted to do so, please upgrade to the latest Azure CLI version by following https://learn.microsoft.com/en-us/cli/azure/update-azure-cli.

Comment by Yong Zhang (@yonzhan)

Thank you for opening this issue, we will look into it.
<<END:issue-32170>>

[azclibot]

This issue is tracked from Azure/azure-cli#32170.

Bug summary: az load test create requires --test-id/-t on the command line even when testId is specified in the YAML configuration file passed via --load-test-config-file. The CLI should read testId from the config file and not require it as a CLI argument when it is already present in the YAML.

Failing command:

az load test create --load-test-resource $LOAD_TEST_RESOURCE -g $LOAD_TEST_RESOURCE_GROUP --load-test-config-file test.yaml --autostop disable

Error:

the following arguments are required: --test-id/-t

Expected behavior: When the YAML config file contains testId: <value>, the CLI should use that value and not require --test-id as a CLI argument.

Example YAML config:

version: v0.1
testId: demosimpleloatst
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx

Environment: azure-cli 2.76.0, load extension 2.1.0

Fix guidance: In the load extension's test create command, before argument validation, check if --load-test-config-file is provided and if so, parse the YAML file to extract testId. If testId is found in the YAML, set the test_id argument value from the config so it satisfies the required argument check. Make --test-id effectively optional when a valid testId is present in the config file.

PR title & description format (required)

This repo enforces a PR format (guide). Please author the PR exactly as follows or CI's Check the Format of Pull Request Title and Content will fail.

Title

• Start with [Load] — square brackets [] for a customer-facing change (added to HISTORY.rst), curly {} if not. A bug fix is customer-facing, so use [].
• Then Fix #10020: to link the issue.
• Then optionally the affected command az <command>:.
• Then a present-tense, capitalized verb (Fix for bug fixes; Add/Change/Deprecate/Remove otherwise) and a concise summary.
• Recommended title: [Load] Fix #10020: az <command>: Fix <concise description of the fix>

Description — follow the PR template and fill in:

• Link the issue — start the Description with a closing keyword so the PR auto-links and closes it: Fixes #10020.
• Related command — the az ... command this affects.
• Description (mandatory) — why the bug happens, what you changed, and the resulting behavior.
• Testing Guide — example command(s) showing the fix works.
• History Notes — leave the title to drive the history note, or add [Load] az <command>: <note> lines for extra notes.
• Keep the template checklist and tick the items you've satisfied.

---

Posted by agent-assist (autonomous bug-fix pipeline).

[yonzhan]

Thank you for opening this issue, we will look into it.