Follow Up: Make '--platform' argument mandatory in CLI #1473
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Partho Sarthi <[email protected]>
Signed-off-by: Partho Sarthi <[email protected]>
amahussein
approved these changes
Dec 20, 2024
parthosa
added a commit
to parthosa/spark-rapids-tools
that referenced
this pull request
Jan 10, 2025
parthosa
added a commit
that referenced
this pull request
Jan 21, 2025
…" (#1498) Fixes #1497. In #1472, the `--platform` argument was made a required parameter in Fire. In our tests, it was found that the short flag -p for platform is no longer functioning. Upon investigation, it seems that Fire does not support short flags for required arguments. This PR reverts the above commit and makes the platform argument optional in Fire. This change will ensure compatibility with the -p flag. The platform argument will still be validated internally to ensure its requirement is enforced. ### Case 1 : Platform not provided ``` spark_rapids qualification --eventlogs "/path/to/dataproc-cpu" --verbose ``` #### STDOUT ``` 2025-01-10 13:35:16,011 INFO spark_rapids_tools.argparser: ...applying argument case: Missing Platform argument 2025-01-10 13:35:16,012 ERROR spark_rapids_tools.argparser: Validation err: 1 validation error for QualifyUserArgModel Cannot run tool cmd without platform argument. Re-run the command providing the platform argument. Error: [type=invalid_argument, input_value=ArgsKwargs((), {'eventlog...ols_config_path': None}), input_type=ArgsKwargs] ``` ### Case 2: Platform provided by `--platform` and `-p` ``` spark_rapids qualification --platform dataproc --eventlogs "/path/to/dataproc-cpu" --verbose spark_rapids qualification -p dataproc --eventlogs "/path/to/dataproc-cpu" --verbose ``` #### STDOUT ``` Report Summary: ---------------------- - Total applications 1 Processed applications 1 Top candidates 0 ---------------------- - Processing Completed! ``` --------- Signed-off-by: Partho Sarthi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1472.
This PR ensures that the
--helpoutput for the CLI command reflects the --platform parameter as mandatory.Current Behavior
Running the command spark_rapids qualification
-- --helpincorrectly shows the platform argument as optional:After this PR