Add a HTML link to XCCDF Values

The readers of the policy HTML page will be able to click
on a link that leads to the upstream definition of an XCCDF Value
on GitHub. This is similar to the link that we provide for rules.

utils/render-policy.py

@@ -44,6 +44,17 @@ def set_policy(self, policy_file):
             .format(policy_title=policy.title, product=self.product)
         )
 
+    def set_all_values_with_metadata(self):
+        resolved_values_dir = os.path.join(self.built_content_path, "values")
+        values = dict()
+        for v_file in os.listdir(resolved_values_dir):
+            v_file_path = os.path.join(resolved_values_dir, v_file)
+            val = ssg.build_yaml.Value.from_yaml(v_file_path)
+            val.relative_definition_location = val.definition_location.replace(
+                self.project_directory, "")
+            values[val.id_] = val
+        self.template_data["values"] = values
+
 
 def parse_args():
     parser = HtmlOutput.create_parser(
@@ -59,5 +70,6 @@ def parse_args():
     args = parse_args()
     renderer = HtmlOutput(args.product, args.build_dir)
     renderer.set_all_rules_with_metadata()
+    renderer.set_all_values_with_metadata()
     renderer.set_policy(args.policy)
     renderer.output_results(args)

utils/render_all_policies.py

@@ -51,6 +51,18 @@ def get_rules(root_abspath: str, built_product_dir: str) -> dict:
     return rules
 
 
+def get_values(root_abspath: str, built_product_dir: str) -> dict:
+    resolved_values_dir = os.path.join(built_product_dir, "values")
+    values = dict()
+    for v_file in os.listdir(resolved_values_dir):
+        v_file_path = os.path.join(resolved_values_dir, v_file)
+        val = ssg.build_yaml.Value.from_yaml(v_file_path)
+        val.relative_definition_location = val.definition_location.replace(
+            root_abspath, "")
+        values[val.id_] = val
+    return values
+
+
 def load_policy(controls_dir: str, policy_id: str) -> ssg.controls.Policy:
     policy_file = os.path.join(controls_dir, policy_id + ".yml")
     policy = ssg.controls.Policy(policy_file)
@@ -60,12 +72,13 @@ def load_policy(controls_dir: str, policy_id: str) -> ssg.controls.Policy:
 
 def render_policy(
         policy: ssg.controls.Policy, product_id: str, rules: list,
-        output_dir: str) -> None:
+        values: list, output_dir: str) -> None:
     output_path = os.path.join(output_dir, policy.id + ".html")
     data = {
         "policy": policy,
         "title": f"Definition of {policy.title} for {product_id}",
-        "rules": rules
+        "rules": rules,
+        "values": values
     }
     utils.template_renderer.render_template(
         data, CONTROLS_TEMPLATE, output_path)
@@ -79,11 +92,12 @@ def main():
     policies_used_in_product = get_used_policies(built_product_dir)
     controls_dir = os.path.join(built_product_dir, "controls")
     rules = get_rules(root_path, built_product_dir)
+    values = get_values(root_path, built_product_dir)
     if not os.path.exists(args.output_dir):
         os.mkdir(args.output_dir)
     for policy_id in policies_used_in_product:
         policy = load_policy(controls_dir, policy_id)
-        render_policy(policy, args.product, rules, args.output_dir)
+        render_policy(policy, args.product, rules, values, args.output_dir)
 
 
 if __name__ == "__main__":

utils/rendering/controls-template.html

@@ -24,7 +24,10 @@ <h2>{{{ control.id }}}: {{{ control.title }}}</h2>
   <ul>
     {{%- for selection in control.selections|sort -%}}
     {{%- if '=' in selection %}}
-    <li>{{{ selection }}}</li>
+    {{% set value_id, value = selection.split('=') %}}
+    {{%- if value_id in values %}}
+    <li><a href="https://github.com/ComplianceAsCode/content/tree/master/{{{ values[value_id].relative_definition_location }}}">{{{ value_id }}}</a> = {{{ value }}}</li>
+    {{%- endif -%}}
     {{%- else %}}
     {{%- if selection in rules %}}
     <li><a href="https://github.com/ComplianceAsCode/content/tree/master/{{{ rules[selection].relative_definition_location }}}">{{{ selection }}}</a>: {{{ rules[selection].title }}}</li>