Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make errors with scenarios' name more clear #3655

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Make errors with scenarios' name more clear #3655

merged 1 commit into from
Mar 27, 2024

Conversation

joanlopez
Copy link
Contributor

@joanlopez joanlopez commented Mar 19, 2024

What?

It slightly modifies the errors related with scenarios' name (like empty or prohibited characters).

Why?

Because, as stated in #3601, the current error messages are misleading.

I might be wrong, but in my opinion, I understand that every object under the scenarios key is a scenario definition, thus the key is the name of the scenario, not the name of the executor (type). Also, that's what can be guessed from our docs:

export const options = {
  scenarios: {
    arbitrary_scenario_name: {
      //Name of executor
      executor: 'ramping-vus',
      // more configuration here
    },
  },
};

So, arbitrary_scenario_name is the scenario name, and ramping-vus is the executor, it's name/type.

Checklist

  • I have performed a self-review of my code.
  • I have added tests for my changes.
  • I have run linter locally (make lint) and all checks pass.
  • I have run tests locally (make tests) and all tests pass.
  • I have commented on my code, particularly in hard-to-understand areas.

Related PR(s)/Issue(s)

Closes #3601

@joanlopez joanlopez self-assigned this Mar 19, 2024
@joanlopez joanlopez requested a review from a team as a code owner March 19, 2024 16:14
@joanlopez joanlopez requested review from mstoykov and oleiade and removed request for a team March 19, 2024 16:14
@joanlopez joanlopez added this to the v0.51.0 milestone Mar 19, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.54%. Comparing base (f27cca5) to head (3c45e26).

❗ Current head 3c45e26 differs from pull request most recent head 02aca9f. Consider uploading reports for the commit 02aca9f to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3655      +/-   ##
==========================================
- Coverage   73.58%   73.54%   -0.05%     
==========================================
  Files         277      275       -2     
  Lines       20247    20242       -5     
==========================================
- Hits        14898    14886      -12     
- Misses       4401     4404       +3     
- Partials      948      952       +4     
Flag Coverage Δ
macos 73.52% <100.00%> (+0.03%) ⬆️
ubuntu 73.52% <100.00%> (+0.02%) ⬆️
windows ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@joanlopez joanlopez merged commit b17d645 into master Mar 27, 2024
23 of 24 checks passed
@joanlopez joanlopez deleted the fix-3601 branch March 27, 2024 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Misleading error message when using invalid character in scenario name
4 participants