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

[testing-toolkit-test-cases] - standardize naming conventions #2620

Open
lewisdaly opened this issue Dec 7, 2021 · 2 comments
Open

[testing-toolkit-test-cases] - standardize naming conventions #2620

lewisdaly opened this issue Dec 7, 2021 · 2 comments
Labels
oss-ttk Related to the Mojaloop testing toolkit ttk-testsuite-optimization

Comments

@lewisdaly
Copy link
Contributor

Summary:
The names of the folders inside the mojaloop/testing-toolkit-test-cases repo are confusing, which makes it hard for contributors to understand the intentions of the tests and add new tests.

We should have well established and consistent names for all of our tests!

For example:

tree collections/hub                                                                                                   Tue 07 Dec 2021 13:51:47
collections/hub
├── golden_path
│   ├── api-tests
│   │   ├── admin-api-tests
│   │   │   └── Admintests-20201221.json
│   │   ├── master.json
│   │   ├── Quotes
│   │   │   └── quotes-negative-scenarios.json
│   │   └── SettlementWindows
│   │       └── settlementadmin.json
│   ├── bug fixes
│   │   ├── master.json
│   │   ├── other-bug-fixes.json
│   │   ├── Test for 4 decimal points #949.json
│   │   ├── Test for Bugfix #1378 - extension list missing.json
│   │   ├── Test for Bugfix #742 - Error code check.json
│   │   ├── Test for Bugfix #849 - missing ID for transfers and quotes.json
│   │   ├── Tests for Bugfix #1009 - ML Adapter and ALS service health should include broker status.json
│   │   ├── Tests for Bugfix #981 - Fix 500 http code instead of 400.json
│   │   ├── Tests for Bugfix #990 and #1016 - Quotes.json
│   │   └── Tests for Bugfix #998 - Quoting service not using most recent endpoint.json
│   ├── feature_tests
│   │   ├── Active_Inactive_participants
│   │   │   ├── active_and_inactive_participant.json
│   │   │   ├── active_and_inactive_participants_accounts.json
│   │   │   └── master.json
│   │   ├── block_transfer.json
│   │   ├── duplicate_handling
│   │   │   └── transfers
│   │   │       ├── fulfill_commit.json
│   │   │       ├── fulfill_reject.json
│   │   │       ├── master.json
│   │   │       └── original_transfer_at_committed.json
│   │   ├── funds_in
│   │   │   └── funds_in_ttk.json
│   │   ├── funds_out
│   │   │   ├── master.json
│   │   │   ├── Reserve&Abort
│   │   │   │   └── funds_out_abort.json
│   │   │   └── Reserve&Commit
│   │   │       └── funds_out_commit.json
│   │   ├── get_transfers.json
│   │   ├── master.json
│   │   ├── p2p_money_transfer
│   │   │   ├── master.json
│   │   │   ├── p2p_happy_path_accent_unicode.json
│   │   │   ├── p2p_happy_path_burmese_unicode.json
│   │   │   ├── p2p_happy_path.json
│   │   │   ├── p2p_happy_path_subid_error_callback.json
│   │   │   └── p2p_happy_path_subid.json
│   │   ├── post_scenarios
│   │   │   ├── master.json
│   │   │   ├── positive.json
│   │   │   └── reserve_notification_positive_testfsp1_testfsp2.json
│   │   └── transfer_negative_scenarios
│   │       ├── fulfil-reserved-v1.0.json
│   │       ├── master.json
│   │       ├── payee_abort_v1.1.json
│   │       ├── payee_invalid_fulfillment.json
│   │       └── payee_invalid_timestamp.json
│   ├── master.json
│   ├── p2p_on_us_transfers
│   │   └── p2p_money_transfer_on_us.json
│   ├── quoting_service
│   │   └── quoting_service.json
│   ├── settlement_cgs
│   │   └── newsetcgs.json
│   ├── settlement_management
│   │   ├── master.json
│   │   ├── mixed_settlement_model.json
│   │   ├── Settlement-management-primary-currency-test.json
│   │   └── Settlement-management-second-currency-test.json
│   └── transaction_request_service
│       ├── authorizations.json
│       ├── Error-framework-authorizations.json
│       ├── error-framework.json
│       ├── master.json
│       ├── received State.json
│       ├── rejected State.json
│       └── transaction_request_service_health.json
├── other_tests
│   ├── bulk_transfers
│   │   ├── master.json
│   │   ├── negative_scenarios.json
│   │   └── positive_scenarios.json
│   ├── new_changes
│   │   └── get_parties_subid.json
│   └── v1.1_changes
│       └── patch_notification.json
├── provisioning
│   ├── CGS_Specific
│   │   ├── add-users-to-new-sims-and-als-registration.json
│   │   ├── adjust-participants-limits.json
│   │   ├── master.json
│   │   └── oracle-onboarding.json
│   ├── master.json
│   ├── MojaloopHub_Setup
│   │   └── hub.json
│   └── MojaloopSims_Onboarding
│       ├── master.json
│       ├── noresponsepayeefsp.json
│       ├── payeefsp.json
│       ├── payerfsp.json
│       ├── testfsp1.json
│       ├── testfsp2.json
│       ├── testfsp3.json
│       ├── testfsp4.json
│       ├── testingtoolkitdfsp.json
│       └── ttkpayeefsp.json
├── provisioning_thirdparty
│   ├── centralauth.json
│   ├── dfspa.json
│   ├── dfspb.json
│   ├── hub.json
│   ├── master.json
│   ├── pisp.json
│   └── README.md
├── sequence
│   ├── account-lookup-service
│   │   ├── Create Batch Participants - [seq-acct-lookup-post-participants-batch-7.1.1].json
│   │   ├── Create Participant - [seq-acct-lookup-post-participant-7.1.3].json
│   │   ├── Delete Participant Details - [seq-acct-lookup-del-participants-7.1.2].json
│   │   ├── Get Participant Details - [seq-acct-lookup-get-participants-7.1.0].json
│   │   └── Get Party Details - [seq-acct-lookup-get-parties-7.2.0].json
│   ├── account-lookup-service-admin
│   │   ├── Create Oracle Endpoints - [seq-acct-lookup-admin-post-oracle-7.3.2].json
│   │   ├── Delete Oracle Endpoints - [seq-acct-lookup-admin-delete-oracle-7.3.4].json.json
│   │   ├── Get Oracles - [seq-acct-lookup-admin-get-oracle-7.3.1].json
│   │   └── Update Oracle Endpoints - [seq-acct-lookup-admin-put-oracle-7.3.3].json
│   └── quoting-service
│       └── Quoting Service Sequences [seq-quote-1.0.0].json
└── thirdparty
    └── collection.json

36 directories, 96 files
  • other-bug-fixes.json we shouldn't use the word 'other' it's too vauge
  • Test for Bugfix #1378 and other Test for ... - this is a repo full of test cases, we can drop the Test for prefix
    /other_tests/ - what does other mean?
  • new_changes - what are new changes? Are they different from v1.1_changes?
  • at what point do v1.1_changes get integrated into the golden path?
    newsetcgs.json makes no sense to me, we can't use words like 'new' as they have very little meaning
  • p2p_on_us_transfers is this a feature?

in general, we should have consistent cases use of - , and _, etc. For example we have the following directories:
api-tests, bug fixes, feature_tests - if we standardize on using _ and drop the redundant tests, these should be api, bug_fixes, features`

I hope you can agree that we need to tidy the names and conventions for our test cases to make them more manageable.

Severity:
(Low, Medium, High)

Priority:
(Critical, Medium, Low)

Expected Behavior

Steps to Reproduce
1.
2.
3.

Specifications

  • Component (if known):
  • Version:
  • Platform:
  • Subsystem:
  • Type of testing:
  • Bug found/raised by:

Notes:

  • Severity when opened:
  • Priority when opened:
@lewisdaly lewisdaly added the bug Something isn't working or it has wrong behavior on a Mojaloop Core service label Dec 7, 2021
@elnyry-sam-k
Copy link
Member

hi @lewisdaly - it was a translation from legacy postman collections so the team used the same conventions to avoid confusion and help teams that are comparing test cases..

We can change these soon; I would avoid using words such as "Poor" in the titles though, personally

And, I don't think its a bug!

@elnyry-sam-k
Copy link
Member

@vijayg10 , @lewisdaly - how do you think we should proceed further on this..

@elnyry-sam-k elnyry-sam-k added oss-ttk Related to the Mojaloop testing toolkit ttk-testsuite-optimization and removed bug Something isn't working or it has wrong behavior on a Mojaloop Core service labels Jan 26, 2022
@elnyry-sam-k elnyry-sam-k changed the title [testing-toolkit-test-cases] - Poor naming conventions [testing-toolkit-test-cases] - standardize naming conventions Jan 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
oss-ttk Related to the Mojaloop testing toolkit ttk-testsuite-optimization
Projects
None yet
Development

No branches or pull requests

2 participants