UXPROD-1845 NFR Scorecard

1

Availability

NFR.Baseline.Availability.1

Modules are designed and implemented following the Stateless principle

Dec 8, 2023 COMPLIANT

Mar 11, 2024 COMPLIANT

• A job triggering dates/status and all the data are in mod-orders-storage. The job can be invoked by a scheduler but this is managed by an RMB scheduler which can avoid 2 jobs running in parallel

• Status change events are published to mod-audit via Kafka

2

NFR.Baseline.Availability.2

Load/performance testing must be conducted for at least 2 instances

Dec 8, 2023 NOT VERIFIED

Apr 15, 2024 COMPLIANT

• ACTION ITEM Manually set up 2 instances of mod-orders-storage on the dev rancher and confirm that there are no issues with concurrent jobs - https://folio-org.atlassian.net/browse/MODORDERS-1029

3

Manageability

NFR.Baseline.Manageability.1

Application logs are collected in a unified form and location

Dec 1, 2023 NOT VERIFIED

Mar 11, 2024 COMPLIANT

• ACTION ITEM Make sure the information regarding job execution (at least, start time, duration, a number of processed pieces) is available in the logs

• See https://github.com/folio-org/mod-orders-storage/blob/master/src/main/java/org/folio/rest/impl/ClaimingAPI.java - there are start time, tenant ID, piece count there

4

NFR.Baseline.Manageability.2

All custom configuration values are placed in the settings, not in the program code

Dec 8, 2023 NOT VERIFIED

Mar 11, 2024 COMPLIANT

• ACTION ITEM Make sure that the job execution start time is configurable via application properties

5

Performance

NFR.Baseline.Performance.1

Components are performance tested and compared to the prior release baseline; performance may not degrade more than 5% in exceptional cases

Dec 8, 2023 Not Applicable

Mar 11, 2024 Not Applicable

• Since the job runs once per day there are no specific requirements or expectations from the performance perspective

6

Security

NFR.Baseline.Security.1

Tenant data must be isolated from other tenants

Dec 8, 2023 NOT VERIFIED

Apr 15, 2024 COMPLIANT

• ACTION ITEM Let's use rancher env with 3 tenants of ECS and make sure this job runs as expected on each tenant - https://folio-org.atlassian.net/browse/MODORDERS-1029

7

NFR.Baseline.Security.2

Secrets (such as usernames, passwords, API keys, and/or their combinations) are not stored in source repositories (i.e. Github)

Dec 8, 2023 Not Applicable

Mar 11, 2024 COMPLIANT

• No secrets or sensitive info

8

NFR.Baseline.Security.3

No sensitive information in logs (logins, passwords, API keys)

Dec 8, 2023 Not Applicable

Mar 11, 2024 COMPLIANT

• No secrets or sensitive info

9

Testability

NFR.Baseline.Testability.1

Unit-test coverage for new code created/changed during the implementation of the feature >= 80%

Dec 8, 2023 NOT VERIFIED

Mar 11, 2024 COMPLIANT

• This is a part of Quality Gates

• https://sonarcloud.io/project/overview?id=org.folio%3Amod-orders

• https://sonarcloud.io/project/overview?id=org.folio%3Amod-orders-storage

10

NFR.Baseline.Testability.2

E2E-test coverage - # of automated test cases from test rail to # of all test cases at a particular feature

Dec 8, 2023 NOT VERIFIED

Mar 11, 2024 COMPLIANT

• Will be handled by AQA team based on the tests provided by dev team manual QAs

11

NFR.Baseline.Testability.3

Karate-test coverage - # of test to # of new endpoints that were created (or existing endpoints that were changed) in the feature scope

Dec 8, 2023  NOT VERIFIED

Mar 11, 2024 COMPLIANT

• ACTION ITEM A dedicated story to prepare Karate tests

• https://github.com/folio-org/folio-integration-tests/pull/1216