UXPROD-4553 NFR Scorecard

Status

IN PROGRESS

Date-time

Apr 29, 2024

Dev Team

Thunderjet

Architect

@Raman Auramau

Product Owner

@Joseph Reimers

Scrum Master

@Mikita Siadykh

Team Lead

@Serhii Nosko

Prod Ticket

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

Arch Ticket

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

Tech Design

https://folio-org.atlassian.net/wiki/spaces/DD/pages/8914168

Release

Ramsons (R2 2024)

 

 

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 29, 2024 COMPLIANT

 

mod-orders, mod-orders-storage, ui-orders, ui-inventory, ui-receiving

2

NFR.Baseline.Availability.2

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

Apr 29, 2024 NOT VERIFIED

 

 

3

Manageability

NFR.Baseline.Manageability.1

Application logs are collected in a unified form and location

Apr 29, 2024 COMPLIANT

 

ACTION It’s required that logs contain tenant ID so that it should be able to easily identify the tenant we work in

4

NFR.Baseline.Manageability.2

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

Apr 29, 2024 COMPLIANT

 

A new configuration is stored in mod-orders-storage

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 29, 2024 NOT VERIFIED

 

ACTION Add Gatling tests for basic ordering and receiving flow

ACTION Test performance impact of ECS on the order creating/closing workflows

6

Security

NFR.Baseline.Security.1

Tenant data must be isolated from other tenants

Apr 29, 2024 NOT VERIFIED

 

 

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 29, 2024 COMPLIANT

 

No new secrets introduced

8

NFR.Baseline.Security.3

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

May 13, 2024 COMPLIANT

 

ACTION Improve logs to see which tenants we are saving data to

9

Testability

NFR.Baseline.Testability.1

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

Apr 29, 2024 NOT VERIFIED

 

 

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 29, 2024 NOT VERIFIED

 

 

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 29, 2024 NOT VERIFIED

 

ACTION Create tasks for Karate tests

LEGEND: Enumeration of possible statuses

Compliance checked and confirmed COMPLIANT

Compliance not checked NOT VERIFIED

Compliance checked, and non-compliance found NON COMPLIANT

Сompliance not required, requirement not applicable NOT VERIFIED

LEGEND: Enumeration of possible statuses

Compliance checked and confirmed COMPLIANT

Compliance not checked NOT VERIFIED

Compliance checked, and non-compliance found NON COMPLIANT

Сompliance not required, requirement not applicable NOT VERIFIED