Skip to content

Commit 8925675

Browse files
committed
add/fix references, add elasticity def
1 parent 26cf768 commit 8925675

File tree

3 files changed

+45
-19
lines changed

3 files changed

+45
-19
lines changed

content/03.intro.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,27 +35,31 @@ The criteria compiled in this document favours a pragmatic and systematic
3535
approach that puts emphasis on the programmatic assessment of the quality
3636
conventions. To this end, the criteria herein compiled builds on the DevOps
3737
culture already established in the preceding Software Quality Assurance baseline
38-
document [5] to outline the set of good practices that seek the usability and
38+
document [@url:https://digital.csic.es/handle/10261/160086] to outline the set
39+
of good practices that seek the usability and
3940
reliability of services, and meet the user expectations in terms of functional
4041
requirements.
4142

4243
## Contextualization of a Service
4344

4445
As a result, a **Service**, as conceived in this document, represent the following:
4546

46-
* Web service [WS] [7]:
47+
* Web service [WS] [@url:https://techterms.com/definition/web_service]:
4748
* A web service is an application or data source that is accessible via
4849
a standard web protocol (HTTP or HTTPS).
4950
* Web services are designed to communicate with other programs,
5051
rather than directly with users.
5152
* Most web services provide an API, or a set of functions and commands,
5253
that can be used to access the data.
5354

54-
* Web application [WApp] [8]:
55+
* Web application [WApp] [@url:https://techterms.com/definition/web_application]:
5556
* A web application or "web app" is a software program that runs on a web server.
5657
* Web apps must be accessed through a web browser.
5758

58-
* Platform [Plat]: an integrated set of Web services, Web applications and software components.
59+
* Platform or Service Composition [Plat]
60+
[@url:https://csrc.nist.gov/glossary/term/Service_Composition]:
61+
* Aggregation of multiple small services into larger services.
62+
* An integrated set of Web services, Web applications and software components.
5963

6064
Examples are: Web portals, Scientific portals and gateways, data repositories.
6165

content/06.quality_criteria.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ such as the EOSC ecosystem. These guidelines rule the **Service** development
77
and operation process within the framework of the EOSC-Synergy project.
88

99
Some of the criteria in this document is similar or based on the
10-
document "Software Quality Assurance baseline2 [5], for such cases the
11-
following tag is added to the criteria: [Ref.5-QC.XyNN] where QC.XyNN is
10+
document "Software Quality Assurance baseline"
11+
[@url:https://digital.csic.es/handle/10261/160086], for such cases the
12+
following tag is added to the criteria: [SQA-QC.XyNN] where QC.XyNN is
1213
the codename of the criteria in that document.
1314

1415
### Integration Testing [SvcQC.Int]
@@ -18,24 +19,28 @@ coupled **Service** or parts of a system that cooperate to achieve a given
1819
functionality.
1920

2021
* **[SvcQC.Int01]** Integration testing outcome MUST guarantee the overall
21-
operation of the **Service** whenever new functionality is involved. [Ref.5-QC.Int01].
22+
operation of the **Service** whenever new functionality is involved. [SQA-QC.Int01].
2223

2324
* **[SvcQC.Int02]** Integration testing SHOULD be automated.
2425

2526
* **[SvcQC.Int03]** Ad-hoc pilot **Service** infrastructures and/or local
26-
testbeds MAY be used to cope with the integration testing requirements. [Ref.5-QC.Int04].
27+
testbeds MAY be used to cope with the integration testing requirements. [SQA-QC.Int04].
2728

2829
### Scalability tests [SvcQC.Sca]
2930

3031
Scalability Testing is a non-functional test methodology in which an
3132
application’s performance is measured in terms of its ability to scale
3233
up or scale down the number of user requests or other such performance
33-
measure attributes [9].
34+
measure attributes [@url:https://www.softwaretestinghelp.com/what-is-scalability-testing/].
3435

3536
* **[SvcQC.Sca01]**
3637

3738
### Elasticity tests [SvcQC.Ela]
3839

40+
Elasticity is the level of autonomous adaptation provided by the
41+
cloud layer in response to variable demand for the software
42+
service [@doi:10.1186/s13677-019-0134-y].
43+
3944
* **[SvcQC.Ela01]**
4045

4146
### Acceptance and System tests [SvcQC.Acc]
@@ -48,26 +53,26 @@ enters into production. Tests for the public API.
4853
### Documentation [SvcQC.Doc]
4954

5055
* **[SvcQC.Doc01]** Documentation MUST be available online, easily
51-
findable and accessible. [Ref.5-QC.Doc03].
56+
findable and accessible. [SQA-QC.Doc03].
5257

5358
* **[SvcQC.Doc02]** Documentation SHOULD have a Persistent Identifier (PID).
5459

55-
* **[SvcQC.Doc03]** Documentation MUST be version controlled. [Ref.5-QC.Doc01.1].
60+
* **[SvcQC.Doc03]** Documentation MUST be version controlled. [SQA-QC.Doc01.1].
5661

5762
* **[SvcQC.Doc04]** Documentation MUST be updated on new **Service** versions
5863
involving any change in the installation, configuration or behaviour of
59-
the **Service**. [Ref.5-QC.Doc04].
64+
the **Service**. [SQA-QC.Doc04].
6065

6166
* **[SvcQC.Doc05]** Documentation MUST be updated whenever reported
62-
as inaccurate or unclear. [Ref.5-QC.Doc05].
67+
as inaccurate or unclear. [SQA-QC.Doc05].
6368

6469
* **[SvcQC.Doc06]** Documentation MUST have a non-software license.
6570

6671
* **[SvcQC.Doc07]** Documentation MUST be produced according to the
6772
target audience, varying according to the **Service** specification.
6873
The identified types of documentation and their RECOMMENDED content are:
6974

70-
* **[SvcQC.Doc07.2]** Deployment and Administration. [Ref.5-QC.Doc06.3]:
75+
* **[SvcQC.Doc07.2]** Deployment and Administration. [SQA-QC.Doc06.3]:
7176
* Installation and configuration guides.
7277
* Service Reference Card, with the following RECOMMENDED content:
7378
* Brief functional description.
@@ -80,7 +85,7 @@ The identified types of documentation and their RECOMMENDED content are:
8085
* List of cron jobs.
8186
* Security information.
8287
* FAQs and troubleshooting.
83-
* **[SvcQC.Doc07.3]** User. [Ref.5-QC.Doc06.4]:
88+
* **[SvcQC.Doc07.3]** User. [SQA-QC.Doc06.4]:
8489
* Detailed User Guide for the **Service**.
8590
* Public API documentation (if applicable).
8691
* Command-line (CLI) reference (if applicable).
@@ -97,13 +102,14 @@ The identified types of documentation and their RECOMMENDED content are:
97102
* **[SvcQC.Sec01]** The **Service** public endpoints and APIs MUST be secured
98103
with encryption.
99104

100-
* **[SvcQC.Sec02]** Dynamic application security testing (DAST) [6]
105+
* **[SvcQC.Sec02]** Dynamic application security testing (DAST)
106+
[@url:https://www.techopedia.com/definition/30958/dynamic-application-security-testing-dast]
101107
SHALL be performed from the outside, to the **Service** in an operation
102108
state, to look for security vulnerabilities (e.g. SQL injection,
103-
cross-site scripting, DDOS). [Ref.5-QC.Sec03].
109+
cross-site scripting, DDOS). [SQA-QC.Sec03].
104110

105111
* **[SvcQC.Sec03]** Manual penetration testing MAY be part of the
106-
application security verification effort. [Ref.5-QC.Sec04].
112+
application security verification effort. [SQA-QC.Sec04].
107113

108114
* **[SvcQC.Sec04]** The **Service** SHOULD have an Authentication mechanism.
109115

@@ -126,7 +132,7 @@ leveraging Infrastructure as Code (IaC) tools.
126132
for operational and users issues.
127133

128134
* **[SvcQC.Sup02]** The **Service** SHOULD have a tracker for the
129-
underlying software issues. [Ref.5-QC.Man01].
135+
underlying software issues. [SQA-QC.Man01].
130136

131137
* **[SvcQC.Sup03]** The **Service** SHOULD include an Operational
132138
Level Agreement (OLA) with the infrastructure where it is integrated.

content/manual-references.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,21 @@
66
"title": "Key words for use in RFCs to Indicate Requirement Levels",
77
"issued": {"date-parts": [[1997]]},
88
"author": [{"given": "Scott", "family": "Bradner"}]
9+
},
10+
{
11+
"type": "article",
12+
"standard_citation": "url:https://digital.csic.es/handle/10261/160086",
13+
"URL": "https://digital.csic.es/handle/10261/160086",
14+
"note": "publisher: CSIC-UC - Instituto de Física de Cantabria (IFCA)",
15+
"title": "A set of common software quality assurance baseline criteria for research projects",
16+
"issued": {"date-parts": [[2017]]},
17+
"author": [
18+
{"family": "Orviz", "given": "Pablo"},
19+
{"family": "López García", "given": "Álvaro"},
20+
{"family": "Duma", "given": "Doina Cristina"},
21+
{"family": "Donvito", "given": "Giacinto"},
22+
{"family": "David", "given": "Mario"},
23+
{"family": "Gomes", "given": "Jorge"}
24+
]
925
}
1026
]

0 commit comments

Comments
 (0)