ssg._checks.is_content_href_remote() - Code Metrics - Inspection of "Merge pull request #2949 from cipherboy/ssg-module" - ComplianceAsCode/content - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 291ee9...9d841e )

by Matěj

created 2018-06-15 13:07 UTC

ssg._checks.is_content_href_remote() A

↳ Parent: ssg._checks

Complexity

Conditions

Size

Total Lines	17
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nop	1
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0

import re
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

from ssg._constants import *



def get_content_ref_if_exists_and_not_remote(check):

    """
    Given an OVAL check element, examine the ``xccdf_ns:check-content-ref``

    If it exists and it isn't remote, pass it as the return value.
    Otherwise, return None.

    ..see-also:: is_content_href_remote
    """
    checkcontentref = check.find("./{%s}check-content-ref" % XCCDF11_NS)

    if checkcontentref is None:
        return None
    if is_content_href_remote(checkcontentref):

        return None
    else:
        return checkcontentref


def is_content_href_remote(check_content_ref):
    """
    Given an OVAL check-content-ref element, examine the 'href' attribute.

    If it starts with 'http://' or 'https://', return True, otherwise
    return False.

    Raises RuntimeError if the ``href`` element doesn't exist.
    """
    hrefattr = check_content_ref.get("href")
    if hrefattr is None:
        # @href attribute of <check-content-ref> is required by XCCDF standard
        msg = "Invalid OVAL <check-content-ref> detected - missing the " \
              "'href' attribute!"
        raise RuntimeError(msg)

    return hrefattr.startswith("http://") or hrefattr.startswith("https://")


def is_cce_valid(cceid):
    """
    IF CCE ID IS IN VALID FORM (either 'CCE-XXXX-X' or 'CCE-XXXXX-X'
    where each X is a digit, and the final X is a check-digit)
    based on Requirement A17:

    http://people.redhat.com/swells/nist-scap-validation/scap-val-requirements-1.2.html
    """
    match = re.match(r'^CCE-\d{4,5}-\d$', cceid)
    return match is not None


1			import re
			0 ignored issues – show Coding Style introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2
3			from ssg._constants import *
			0 ignored issues – show Coding Style introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report The usage of wildcard imports like `ssg._constants` should generally be avoided. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `datetime` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `os` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `JINJA_MACROS_DEFINITIONS` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `xml_version` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `datastream_namespace` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `ocil_namespace` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `oval_footer` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `oval_namespace` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `ocil_cs` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `xccdf_header` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `xccdf_footer` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `bash_system` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `ansible_system` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `puppet_system` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `anaconda_system` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `cce_uri` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `stig_ns` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `ssg_version_uri` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `OSCAP_VENDOR` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `OSCAP_DS_STRING` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `OSCAP_GROUP` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `OSCAP_GROUP_PCIDSS` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `OSCAP_GROUP_VAL` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `OSCAP_GROUP_NON_PCI` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `XCCDF12_NS` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `min_ansible_version` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `ansible_version_requirement_pre_task_name` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `oval_header` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `timestamp` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report `PKG_MANAGER_TO_SYSTEM` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 18:48 UTC by Report Bug Copy Issue Report `disa_cciuri` was imported with wildcard, but is not used. Loading history... Unused Code introduced 2018-06-13 18:48 UTC by Report Bug Copy Issue Report `disa_srguri` was imported with wildcard, but is not used. Loading history...
4
5
6			def get_content_ref_if_exists_and_not_remote(check):
			0 ignored issues – show Coding Style Naming introduced 2018-06-13 18:48 UTC by Report Bug Copy Issue Report The name `get_content_ref_if_exists_and_not_remote` does not conform to the function naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
7			"""
8			Given an OVAL check element, examine the ``xccdf_ns:check-content-ref``
9
10			If it exists and it isn't remote, pass it as the return value.
11			Otherwise, return None.
12
13			..see-also:: is_content_href_remote
14			"""
15			checkcontentref = check.find("./{%s}check-content-ref" % XCCDF11_NS)
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-06-13 12:58 UTC by Report Bug Copy Issue Report The variable `XCCDF11_NS` does not seem to be defined. Loading history...
16			if checkcontentref is None:
17			return None
18			if is_content_href_remote(checkcontentref):
			0 ignored issues – show unused-code introduced 2018-06-13 18:48 UTC by Report Bug Copy Issue Report Unnecessary "else" after "return" Loading history...
19			return None
20			else:
21			return checkcontentref
22
23
24			def is_content_href_remote(check_content_ref):
25			"""
26			Given an OVAL check-content-ref element, examine the 'href' attribute.
27
28			If it starts with 'http://' or 'https://', return True, otherwise
29			return False.
30
31			Raises RuntimeError if the ``href`` element doesn't exist.
32			"""
33			hrefattr = check_content_ref.get("href")
34			if hrefattr is None:
35			# @href attribute of <check-content-ref> is required by XCCDF standard
36			msg = "Invalid OVAL <check-content-ref> detected - missing the " \
37			"'href' attribute!"
38			raise RuntimeError(msg)
39
40			return hrefattr.startswith("http://") or hrefattr.startswith("https://")
41
42
43			def is_cce_valid(cceid):
44			"""
45			IF CCE ID IS IN VALID FORM (either 'CCE-XXXX-X' or 'CCE-XXXXX-X'
46			where each X is a digit, and the final X is a check-digit)
47			based on Requirement A17:
48
49			http://people.redhat.com/swells/nist-scap-validation/scap-val-requirements-1.2.html
50			"""
51			match = re.match(r'^CCE-\d{4,5}-\d$', cceid)
52			return match is not None
53

ComplianceAsCode / content

Push — master ( 291ee9...9d841e )

ssg._checks.is_content_href_remote() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like