From 2299022b38e9a9ef0a32b8ee424aa55cbc852cc5 Mon Sep 17 00:00:00 2001 From: "A. Wilcox" Date: Thu, 26 Sep 2019 02:30:09 -0500 Subject: req: Add logging and quality requirements --- devel/requirements/5_nonfunctional.xml | 36 ++++++++++++++++++++++++++++++++++ devel/requirements/6_other.xml | 31 +++++++++++++++++++++++++++-- 2 files changed, 65 insertions(+), 2 deletions(-) diff --git a/devel/requirements/5_nonfunctional.xml b/devel/requirements/5_nonfunctional.xml index e8b2c82..22ab53b 100644 --- a/devel/requirements/5_nonfunctional.xml +++ b/devel/requirements/5_nonfunctional.xml @@ -28,5 +28,41 @@ SQA.Flexibility.FirmwareConf The firmware support described under the UI.Firmware.* requirements branch shall be disableable at run-time via a configuration setting. + + SQA.Robustness.ScriptSync + The system shall provide a method to save the executed HorizonScript and log messages in the event of a fatal error. + + + SQA.Usability.TTI.Experienced + A User with experience installing other Linux distributions shall be able to complete the Horizon UI flow through in less than 15 minutes. + + + SQA.Usability.TTI.Green + A User with no prior experience with Linux shall be able to complete the Horizon UI flow through in less than one hour. + + + SQA.Portability.Bitness + A HorizonScript shall be readable on 32-bit and 64-bit computers regardless of what type of computer was used to create it. + + + SQA.Portability.Endianness + A HorizonScript shall be readable on big endian and little endian computers regardless of what type of computer was used to create it. + + + SQA.Verifiability.BlockMock + The system shall support the ability to use "mock" block devices for purposes of testing and verification. + + + SQA.Maintainability.Comments + All functions and methods in the system shall have a comment describing what action the function or method performs, and its inputs, outputs, and any side effects (if applicable). + + + SQA.Maintainability.Methods + Each class in the system shall have no more than 20 methods. + + + SQA.Maintainability.NoOPFuncs + Each function or method in the system shall take no more than six input parameters. + diff --git a/devel/requirements/6_other.xml b/devel/requirements/6_other.xml index c5aba8b..227a8bb 100644 --- a/devel/requirements/6_other.xml +++ b/devel/requirements/6_other.xml @@ -1,7 +1,7 @@ Other Requirements - + This chapter describes requirements that apply to the system but do not fit cleanly in other chapters.
User Documentation @@ -15,7 +15,34 @@
Logging Requirements - + + Logging.Levels + The system shall have four levels of logging: Error, Warning, Information, Debug. + + + Logging.Levels.Tiers + The system shall treat each level of logging as containing the prior level: for example, a level of Warning will additionally contain all Error output. + + + Logging.Levels.Default + The system shall default to a logging level of Information unless a different logging level is chosen during invocation. + + + Logging.ExtProcess + The system shall log all processes executed, including binary path, arguments, and environment, in the Debug logging level. + + + Logging.ExtProcess.ReturnCode + The system shall log all external process return codes, including name of binary and brief description of purpose of execution, in the Information log level. + + + Logging.ExtProcess.ReturnCode.Error + If the return code of an external process is non-zero, the system shall log the external process return code message in the Error log level. + + + Logging.UIKeys + The Horizon UI system shall log the values it uses for each key as it gathers information in the Debug logging level. +
Internationalisation Requirements -- cgit v1.2.3-70-g09d2