UXPROD-4006 NFR Scorecard

UXPROD-4006 NFR Scorecard

Please, refer to NFR Scorecard practice for detailed information

 

Status

COMPLETED

Date-time

Jun 21, 2023 

Dev Team

Firebird

Architect

@Taras Spashchenko 

Team Lead

@Viachaslau Khandramai 

Scrum Master

@Mikita Siadykh 

Product Owner

@Magda Zacharska 

Prod Ticket

https://folio-org.atlassian.net/browse/UXPROD-4006

Arch Ticket

 

Tech Design

 

Release

Poppy (R2 2023)

 

Quality Attribute

NFR ID

Non-Functional Requirement

Date and Status before the start of the work

Date and Status after the completion of the work

Notes

Availability

NFR.Availability.1

Modules are designed and implemented following the Stateless principle

Apr 5, 2023 COMPLIANT

Jun 21, 2023 COMPLIANT

 

NFR.Availability.2

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

Apr 5, 2023 COMPLIANT

Jun 21, 2023 COMPLIANT

 

Manageability

NFR.Manageability.1

Application logs are collected in unified form and location

Apr 5, 2023 COMPLIANT

Jun 21, 2023 COMPLIANT

 

NFR.Manageability.2

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

Apr 5, 2023 COMPLIANT

Jun 21, 2023 COMPLIANT

Vertx timeouts are hardcoded

Performance

NFR.Performance.1

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

Apr 5, 2023 NOT VERIFIED

 

Compliant up to Orchid release. To be re-tested after the implementation of this feature.

6/21/2023: Will need ticket for the PTF team to run the performance

Security

NFR.Security.1

Tenant data must be isolated from other tenants

Apr 5, 2023 COMPLIANT

Jun 21, 2023 COMPLIANT

 

NFR.Security.2

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

Apr 5, 2023 COMPLIANT

Jun 21, 2023 COMPLIANT

 

NFR.Security.3

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

Apr 5, 2023 NOT VERIFIED

 

We need to make sure that API key is not stored in the logs

6/21/2023 Not related to this particular feature but we store API key in the logs. It will be addressed in MODOAIPMH-555

Testability

NFR.Testability.1

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

Apr 5, 2023 COMPLIANT

Jun 21, 2023 COMPLIANT

 

NFR.Testability.2

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

Apr 5, 2023 Not Applicable

Jun 21, 2023 Not Applicable

 

NFR.Testability.3

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

Apr 5, 2023 NOT VERIFIED

Jun 21, 2023 Not Applicable

No new endpoints were added in scope of this feature

 

LEGEND: Enumeration of possible statuses

 

COMPLIANT Compliance checked and confirmed

NOT VERIFIED Compliance not checked

NON COMPLIANT Compliance checked, and non-compliance found

Not Applicable Сompliance not required, requirement not applicable