10076670541

Committed 24 Jul 2024 12:30PM UTC coverage: 63.162% (-1.9%) from 65.07%

Build # 10076670541

Build Type

push

github

Committed by

huberrob

Commit Message

Merge remote-tracking branch 'origin/master'

Run Details

2007 of 3019 branches covered (66.48%)

Branch coverage included in aggregate %.

965 of 2593 new or added lines in 40 files covered. (37.22%)

613 existing lines in 18 files now uncovered.

7624 of 12229 relevant lines covered (62.34%)

0.62 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

14.02

/fuji_server/evaluators/fair_evaluator_development_metadata.py

# SPDX-FileCopyrightText: 2020 PANGAEA (https://www.pangaea.de/)
#
# SPDX-License-Identifier: MIT

from fuji_server.evaluators.fair_evaluator import FAIREvaluator
from fuji_server.models.development_metadata import DevelopmentMetadata
from fuji_server.models.development_metadata_output import DevelopmentMetadataOutput


class FAIREvaluatorDevelopmentMetadata(FAIREvaluator):
    """
    A class to evaluate whether the software includes development metadata which helps define its status (FRSM-05). A child class of FAIREvaluator.
    ...

    Methods
    ------
    evaluate()
        This method will evaluate whether the software has machine-readable descriptive metadata associated with it that describes its development and status.
    """

    def __init__(self, fuji_instance):
        FAIREvaluator.__init__(self, fuji_instance)
        metric = "FRSM-05-R1"
        self.set_metric(metric)

        # Create map from metric test names to class functions. This is necessary as functions may be reused for different metrics relating to licenses.
        self.metric_test_map = {  # overall map
            "testContactInformation": ["FRSM-05-R1-1"],
            "testDevelopmentStatus": ["FRSM-05-R1-2"],
            "testMetadataFormat": ["FRSM-05-R1-3"],
            "testReadme": ["FRSM-05-R1-CESSDA-1"],
            "testVersionNumbering": ["FRSM-05-R1-CESSDA-2"],
        }

    def testContactInformation(self):
        """The software includes metadata for contact or support in the README or other intrinsic metadata file according to community standards.

        Returns:
            bool: True if the test was defined and passed. False otherwise.
        """
        agnostic_test_name = "testContactInformation"
        test_status = False
        test_defined = False
        for test_id in self.metric_test_map[agnostic_test_name]:
            if self.isTestDefined(test_id):
                test_defined = True
                break
        if test_defined:
            self.logger.warning(f"{self.metric_identifier} : Test for contact information is not implemented.")
        return test_status

    def testDevelopmentStatus(self):
        """The software includes metadata for development status, links to documentation.

        Returns:
            bool: True if the test was defined and passed. False otherwise.
        """
        agnostic_test_name = "testDevelopmentStatus"
        test_status = False
        test_defined = False
        for test_id in self.metric_test_map[agnostic_test_name]:
            if self.isTestDefined(test_id):
                test_defined = True
                break
        if test_defined:
            self.logger.warning(
                f"{self.metric_identifier} : Test for development status in metadata is not implemented."
            )
        return test_status

    def testMetadataFormat(self):
        """The metadata is contained in a format such as CodeMeta or ProjectObjectModel that enables full machine-actionability.

        Returns:
            bool: True if the test was defined and passed. False otherwise.
        """
        agnostic_test_name = "testMetadataFormat"
        test_status = False
        test_defined = False
        for test_id in self.metric_test_map[agnostic_test_name]:
            if self.isTestDefined(test_id):
                test_defined = True
                break
        if test_defined:
            self.logger.warning(f"{self.metric_identifier} : Test for metadata format is not implemented.")
        return test_status

    def testReadme(self):
        """The README and CHANGELOG must be up to date.
        he README contains release details, version details, links to documentation as described in the EURISE Network Technical Reference.

        Returns:
            bool: True if the test was defined and passed. False otherwise.
        """
        agnostic_test_name = "testReadme"
        test_status = False
        test_defined = False
        for test_id in self.metric_test_map[agnostic_test_name]:
            if self.isTestDefined(test_id):
                test_defined = True
                break
        if test_defined:
            self.logger.warning(f"{self.metric_identifier} : Test for README information is not implemented.")
        return test_status

    def testVersionNumbering(self):
        """Version numbering follows Semantic Versioning 2.0.0 and pre-release versions may be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version.

        Returns:
            bool: True if the test was defined and passed. False otherwise.
        """
        agnostic_test_name = "testVersionNumbering"
        test_status = False
        test_defined = False
        for test_id in self.metric_test_map[agnostic_test_name]:
            if self.isTestDefined(test_id):
                test_defined = True
                break
        if test_defined:
            self.logger.warning(f"{self.metric_identifier} : Test for version numbering format is not implemented.")
        return test_status

    def evaluate(self):
        if self.metric_identifier in self.metrics:
            self.result = DevelopmentMetadata(
                id=self.metric_number, metric_identifier=self.metric_identifier, metric_name=self.metric_name
            )
            self.output = DevelopmentMetadataOutput()
            self.result.test_status = "fail"
            if self.testContactInformation():
                self.result.test_status = "pass"
            if self.testDevelopmentStatus():
                self.result.test_status = "pass"
            if self.testMetadataFormat():
                self.result.test_status = "pass"
            if self.testReadme():
                self.result.test_status = "pass"
            if self.testVersionNumbering():
                self.result.test_status = "pass"
            else:
                self.result.test_status = "fail"
                self.score.earned = 0
                self.logger.warning(self.metric_identifier + " : Failed to check the software development metadata.")
            self.result.score = self.score
            self.result.metric_tests = self.metric_tests
            self.result.output = self.output
            self.result.maturity = self.maturity

1	# SPDX-FileCopyrightText: 2020 PANGAEA (https://www.pangaea.de/)
2	#
3	# SPDX-License-Identifier: MIT
4
5	from fuji_server.evaluators.fair_evaluator import FAIREvaluator	1✔
6	from fuji_server.models.development_metadata import DevelopmentMetadata	1✔
7	from fuji_server.models.development_metadata_output import DevelopmentMetadataOutput	1✔
8
9
10	class FAIREvaluatorDevelopmentMetadata(FAIREvaluator):	1✔
11	"""
12	A class to evaluate whether the software includes development metadata which helps define its status (FRSM-05). A child class of FAIREvaluator.
13	...
14
15	Methods
16	------
17	evaluate()
18	This method will evaluate whether the software has machine-readable descriptive metadata associated with it that describes its development and status.
19	"""
20
21	def __init__(self, fuji_instance):	1✔
22	FAIREvaluator.__init__(self, fuji_instance)	1✔
23	metric = "FRSM-05-R1"	1✔
24	self.set_metric(metric)	1✔
25
26	# Create map from metric test names to class functions. This is necessary as functions may be reused for different metrics relating to licenses.
27	self.metric_test_map = { # overall map	1✔
28	"testContactInformation": ["FRSM-05-R1-1"],
29	"testDevelopmentStatus": ["FRSM-05-R1-2"],
30	"testMetadataFormat": ["FRSM-05-R1-3"],
31	"testReadme": ["FRSM-05-R1-CESSDA-1"],
32	"testVersionNumbering": ["FRSM-05-R1-CESSDA-2"],
33	}
34
35	def testContactInformation(self):	1✔
36	"""The software includes metadata for contact or support in the README or other intrinsic metadata file according to community standards.
37
38	Returns:
39	bool: True if the test was defined and passed. False otherwise.
40	"""
NEW 41	agnostic_test_name = "testContactInformation"	×
NEW 42	test_status = False	×
NEW 43	test_defined = False	×
NEW 44	for test_id in self.metric_test_map[agnostic_test_name]:	×
NEW 45	if self.isTestDefined(test_id):	×
NEW 46	test_defined = True	×
NEW 47	break	×
NEW 48	if test_defined:	×
NEW 49	self.logger.warning(f"{self.metric_identifier} : Test for contact information is not implemented.")	×
NEW 50	return test_status	×
51
52	def testDevelopmentStatus(self):	1✔
53	"""The software includes metadata for development status, links to documentation.
54
55	Returns:
56	bool: True if the test was defined and passed. False otherwise.
57	"""
NEW 58	agnostic_test_name = "testDevelopmentStatus"	×
NEW 59	test_status = False	×
NEW 60	test_defined = False	×
NEW 61	for test_id in self.metric_test_map[agnostic_test_name]:	×
NEW 62	if self.isTestDefined(test_id):	×
NEW 63	test_defined = True	×
NEW 64	break	×
NEW 65	if test_defined:	×
NEW 66	self.logger.warning(	×
67	f"{self.metric_identifier} : Test for development status in metadata is not implemented."
68	)
NEW 69	return test_status	×
70
71	def testMetadataFormat(self):	1✔
72	"""The metadata is contained in a format such as CodeMeta or ProjectObjectModel that enables full machine-actionability.
73
74	Returns:
75	bool: True if the test was defined and passed. False otherwise.
76	"""
NEW 77	agnostic_test_name = "testMetadataFormat"	×
NEW 78	test_status = False	×
NEW 79	test_defined = False	×
NEW 80	for test_id in self.metric_test_map[agnostic_test_name]:	×
NEW 81	if self.isTestDefined(test_id):	×
NEW 82	test_defined = True	×
NEW 83	break	×
NEW 84	if test_defined:	×
NEW 85	self.logger.warning(f"{self.metric_identifier} : Test for metadata format is not implemented.")	×
NEW 86	return test_status	×
87
88	def testReadme(self):	1✔
89	"""The README and CHANGELOG must be up to date.
90	he README contains release details, version details, links to documentation as described in the EURISE Network Technical Reference.
91
92	Returns:
93	bool: True if the test was defined and passed. False otherwise.
94	"""
NEW 95	agnostic_test_name = "testReadme"	×
NEW 96	test_status = False	×
NEW 97	test_defined = False	×
NEW 98	for test_id in self.metric_test_map[agnostic_test_name]:	×
NEW 99	if self.isTestDefined(test_id):	×
NEW 100	test_defined = True	×
NEW 101	break	×
NEW 102	if test_defined:	×
NEW 103	self.logger.warning(f"{self.metric_identifier} : Test for README information is not implemented.")	×
NEW 104	return test_status	×
105
106	def testVersionNumbering(self):	1✔
107	"""Version numbering follows Semantic Versioning 2.0.0 and pre-release versions may be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version.
108
109	Returns:
110	bool: True if the test was defined and passed. False otherwise.
111	"""
NEW 112	agnostic_test_name = "testVersionNumbering"	×
NEW 113	test_status = False	×
NEW 114	test_defined = False	×
NEW 115	for test_id in self.metric_test_map[agnostic_test_name]:	×
NEW 116	if self.isTestDefined(test_id):	×
NEW 117	test_defined = True	×
NEW 118	break	×
NEW 119	if test_defined:	×
NEW 120	self.logger.warning(f"{self.metric_identifier} : Test for version numbering format is not implemented.")	×
NEW 121	return test_status	×
122
123	def evaluate(self):	1✔
NEW 124	if self.metric_identifier in self.metrics:	×
NEW 125	self.result = DevelopmentMetadata(	×
126	id=self.metric_number, metric_identifier=self.metric_identifier, metric_name=self.metric_name
127	)
NEW 128	self.output = DevelopmentMetadataOutput()	×
NEW 129	self.result.test_status = "fail"	×
NEW 130	if self.testContactInformation():	×
NEW 131	self.result.test_status = "pass"	×
NEW 132	if self.testDevelopmentStatus():	×
NEW 133	self.result.test_status = "pass"	×
NEW 134	if self.testMetadataFormat():	×
NEW 135	self.result.test_status = "pass"	×
NEW 136	if self.testReadme():	×
NEW 137	self.result.test_status = "pass"	×
NEW 138	if self.testVersionNumbering():	×
NEW 139	self.result.test_status = "pass"	×
140	else:
NEW 141	self.result.test_status = "fail"	×
NEW 142	self.score.earned = 0	×
NEW 143	self.logger.warning(self.metric_identifier + " : Failed to check the software development metadata.")	×
NEW 144	self.result.score = self.score	×
NEW 145	self.result.metric_tests = self.metric_tests	×
NEW 146	self.result.output = self.output	×
NEW 147	self.result.maturity = self.maturity	×

pangaea-data-publisher / fuji / 10076670541

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous