UXPROD-4693 NFR Scorecard

UXPROD-4693 NFR Scorecard

Status

IN PROGRESS 

Date-time

Apr 16, 2024 

Dev Team

Spitfire

Architect

@Kalibek Turgumbayev

Product Owner

@Christine Schultz

Scrum Master

@Natalia Zaitseva

Team Lead

@Pavlo Smahin

Prod Ticket

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

Arch Ticket

https://folio-org.atlassian.net/browse/ARCH-248

Tech Design

Browse Instance classification numbers - Phase 1 POC

Release

 

Technical Design

The NFR Scorecard includes the technical design first introduced in the Q release under the feature https://folio-org.atlassian.net/browse/UXPROD-4120 with architectural ticket https://folio-org.atlassian.net/browse/ARCH-151

 

Quality Attribute

NFR ID

Non-Functional Requirement

Preliminary Analysis (Before feature started)- Date and Status

Final Analysis (After feature completed) - Date and Status

Notes and Comments

1

Availability

NFR.Baseline.Availability.1

Modules are designed and implemented following the Stateless principle

Apr 18, 2024  COMPLIANT

 

 

2

NFR.Baseline.Availability.2

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

Apr 18, 2024  COMPLIANT

 

 

3

Manageability

NFR.Baseline.Manageability.1

Application logs are collected in a unified form and location

Apr 18, 2024  COMPLIANT

 

 

4

NFR.Baseline.Manageability.2

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

Apr 18, 2024  COMPLIANT

 

 

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

Apr 18, 2024  NOT VERIFIED

 

https://folio-org.atlassian.net/browse/PERF-889

 

Maintainability

NFR.ClassificationBrowse.Maintainability.1

The extension of functionality should not require changing technical solution

Apr 18, 2024  COMPLIANT

 

 

6

Security

NFR.Baseline.Security.1

Tenant data must be isolated from other tenants

Apr 18, 2024  COMPLIANT

 

For ECS environment sharing the data in central tenant is intended

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)

Apr 18, 2024  COMPLIANT

 

 

8

NFR.Baseline.Security.3

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

Apr 18, 2024  COMPLIANT

 

 

9

Testability

NFR.Baseline.Testability.1

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

Apr 18, 2024  COMPLIANT

 

 

10

 

NFR.Baseline.Testability.2

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

Apr 18, 2024  COMPLIANT

 

 

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

Apr 18, 2024  COMPLIANT

 

 

 

Interoperability

NFR.ClassificationBrowse.Interoperability.1

The solution should provide the capability to support the ECS environment

Apr 18, 2024  COMPLIANT

 

 

 

Reusability

NFR.ClassificationBrowse.Reusability.1

The solution should provide an approach that can be reused for a group of similar search indexes.

Apr 18, 2024  COMPLIANT

 

 

 

Accessibility

NFR.MarcValidation.Accessibility.1

Automated tests for WCAG 2.1 AA compliance

Apr 18, 2024  COMPLIANT

 

 

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