From 9948b07f7666c03ab3ebbd3e2f198f406ed02c01 Mon Sep 17 00:00:00 2001 From: Biedermann Steve Date: Wed, 8 May 2024 14:20:57 +0200 Subject: [PATCH] update --- req.yml | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/req.yml b/req.yml index 358d574..6c46962 100644 --- a/req.yml +++ b/req.yml @@ -62,33 +62,33 @@ topics: REQ-1: name: Cloud Activation description: |- - The remote journal logging **_SHALL_** be startable through a function call from the cloud. + The remote journal logging shall be startable through a function call from the cloud. The api call has the duration and max interval as arguments. REQ-2: name: Duration - description: The remote journal logging **_SHOULD_** stay active, until it reaches the specified duration. + description: The remote journal logging should stay active, until it reaches the specified duration. REQ-3: name: Max Interval description: |- If no upload was done after the amount of time specified in max interval, - a log rotation **_SHALL_** be triggered, which will in turn get picked up by the file monitoring. + a log rotation shall be triggered, which will in turn get picked up by the file monitoring. REQ-4: name: Analytics Not Accepted description: |- - If the user has not accepted the usage of their data, the cloud call **_MUST_** + If the user has not accepted the usage of their data, the cloud call must result in an error. SUB-2: name: File Monitoring requirements: REQ-1: name: Continuous Monitoring - description: The tool **_SHOULD_** continuously monitor a designated directory. + description: The tool should continuously monitor a designated directory. SUB-3: name: File Detection requirements: REQ-1: name: Detection of New Files - description: The tool **_MUST_** detect the addition of new files in the monitored directory. + description: The tool must detect the addition of new files in the monitored directory. REQ-2: name: Avoid Re-processing description: The tool must not process files that have already been processed. @@ -97,72 +97,72 @@ topics: requirements: REQ-1: name: File Upload - description: When a file gets detected, it **_SHOULD_** get uploaded to the cloud. + description: When a file gets detected, it should get uploaded to the cloud. REQ-2: name: No Duplicate Files - description: Already processed files **_MUST NOT_** get uploaded again. + description: Already processed files must not get uploaded again. REQ-3: name: Revoking Analytics description: |- - If the user revokes the usage of their data, the service **_MAY_** continue running - but **_MUST NOT_** upload any data until the user allows the usage of their data again. + If the user revokes the usage of their data, the service may continue running + but must not upload any data until the user allows the usage of their data again. REQ-4: name: Duration Expired - description: After the specified duration is expired, the service **_SHOULD_** stop uploading files. + description: After the specified duration is expired, the service should stop uploading files. FEAT-3: name: Configuration requirements: REQ-1: name: Journal Directory - description: Users **_SHOULD_** be able to specify the directory to be monitored for journal files. + description: Users should be able to specify the directory to be monitored for journal files. REQ-2: name: Output Directory - description: Users **_SHOULD_** be able to specify the directory into which the final files will be written. + description: Users should be able to specify the directory into which the final files will be written. REQ-3: name: Trigger Priority - description: Users **_SHOULD_** be able to specify which priority triggers the filtering. + description: Users should be able to specify which priority triggers the filtering. REQ-4: name: Journal Context - description: Users **_SHOULD_** be able to specify how many seconds of context will be added + description: Users should be able to specify how many seconds of context will be added to traced logs when encountering a trigger priority. REQ-5: name: Max File Size - description: Users **_SHOULD_** be able to specify the max file size, at which a file gets rotated. + description: Users should be able to specify the max file size, at which a file gets rotated. REQ-6: name: Max Directory Size - description: Users **_SHOULD_** be able to specify the max directory size, at which a directory gets rotated. + description: Users should be able to specify the max directory size, at which a directory gets rotated. REQ-7: name: File Monitoring Interval description: |- - Users **_SHOULD_** be able to specify an interval, which **_SHOULD_** change + Users should be able to specify an interval, which should change how long the tool waits before checking if new files are available. FEAT-4: name: Performance Requirements requirements: REQ-1: name: Efficiency - description: The tool **_SHOULD_** efficiently monitor and process files without excessive resource consumption. + description: The tool should efficiently monitor and process files without excessive resource consumption. REQ-2: name: Interval Delay - description: The tool **_SHOULD_** do its work with no more than 10 seconds delay after its interval. + description: The tool should do its work with no more than 10 seconds delay after its interval. FEAT-5: name: Data Protection requirements: REQ-1: name: No Insecure Connection - description: The tool **_MUST_** send data only through a secure connection. + description: The tool must send data only through a secure connection. REQ-2: name: GDPR compliance - description: The tool **_MUST NOT_** upload data if the user has not agreed to share this information. + description: The tool must not upload data if the user has not agreed to share this information. FEAT-6: name: Testing requirements: REQ-1: name: Unit Tests - description: Comprehensive unit tests **_SHOULD_** be written to cover major functionalities. + description: Comprehensive unit tests should be written to cover major functionalities. REQ-2: name: Integration Tests - description: Integration tests **_SHOULD_** be conducted to ensure all parts of the tool work together seamlessly. + description: Integration tests should be conducted to ensure all parts of the tool work together seamlessly. definitions: - name: Default Journal Directory