Refactor Autosuggest component test file to new format #3327
Conversation
precious-onyenaucheya-ons
added
the
Tech improvements
✅ Deploy Preview for ons-design-system-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
precious-onyenaucheya-ons
changed the title
precious-onyenaucheya-ons
changed the title
rmccar
changed the title
| test('THEN: it has language set to "en-gb"', () => { | ||
| expect($('.ons-autosuggest').attr('data-lang')).toBe('en-gb'); | ||
| }); |
There was a problem hiding this comment.
Only required params should be inside this "when" unless you are testing defaults. I don't think this param is required and theres probably a few others too such as the result threshold one. I think we need to review these, keep the ones that test defaults move the others. Then for the ones that have defaults make sure the defaults are tested here and have another test to test what you pass in is overriding that default
There was a problem hiding this comment.
I think the params still need to be reviewed. Theres still some params in there that aren't required
precious-onyenaucheya-ons
force-pushed
the
feature/134/autosuggest-testing-refactor
branch
from
6096db1
to
9915198
Compare
There was a problem hiding this comment.
I think you need to check the required the params in the documentation some of these in the required describe aren't required still. Also the "params none" describe you've added actually passes in a lot of params because it uses EXAMPLE_AUTOSUGGEST. I don't think we need this describe though, we should be testing these things with the required params because we expect those params to be passed in
precious-onyenaucheya-ons
force-pushed
the
feature/134/autosuggest-testing-refactor
branch
from
b7fe5c4
to
1f43ccc
Compare
| @@ -18,4 +18,4 @@ | |||
| | input | `Input` [_(ref)_](/components/input) | true | Configuration object for the input | | |||
| | language | string | false | The ISO 639-1 Code will override the default language in page. Please note that only 'en', 'cy' and 'ni' is currently supported | | |||
| | resultsThreshold | float | false | Option to adjust the search threshold and fuzziness. Accepts a range from 0 to 1, where 0 provides the closest match and 1 allows for more distant matches. Defaults to 0.2. | | |||
| | id | string | false | The `id` of the input | | |||
| | id | string | true | The `id` of the input | | |||
There was a problem hiding this comment.
I assume this is a correction rather than an alteration since I can't see a change in the code to require this field and there is no mention in the ticket itself?
What is the context of this PR?
Fixes: ONSdigital/design-team#134
This PR involves refactoring of the autosuggest test document to follow the Given, When, Then testing approach.
How to review this PR
Functionality:
Does this testing refactor meet the following success criteria:
Look at the refactored code in relation to:
Checklist
This needs to be completed by the person raising the PR.