Use Keystone properties to load VO mapping.

Mark as deprecated the usage of mapping file, and load from Keystone
properties the VO mapping, removing the need of maintaining a different
file.

Sem-Ver: deprecation
Sem-Ver: feature

Author: alvarolopez

caso/extract/base.py

@@ -46,7 +46,11 @@
         "mapping_file",
         default="/etc/caso/voms.json",
         deprecated_group="extractor",
-        help="File containing the VO <-> project mapping as used " "in Keystone-VOMS.",
+        deprecated_for_removal=True,
+        deprecated_reason="This option is marked for removal in the next release. "
+        "Please see the release notes, and migrate your current configuration "
+        "to use the project_mapping file as soon as possible.",
+        help="File containing the VO <-> project mapping as used in Keystone-VOMS.",
     ),
 ]
 
@@ -144,14 +148,17 @@ def __init__(self, project):
         """Initialize extractor, loading the VO map."""
         self.project = project
 
+    @property
+    def voms_map(self):
+        """Get the VO map."""
         # FIXME(remove this)
         try:
             mapping = json.loads(open(CONF.mapping_file).read())
         except ValueError:
             # FIXME(aloga): raise a proper exception here
             raise
         else:
-            self.voms_map = {}
+            voms_map = {}
             for vo, vomap in six.iteritems(mapping):
                 tenant = vomap.get("tenant", None)
                 tenants = vomap.get("tenants", [])
@@ -172,7 +179,8 @@ def __init__(self, project):
                 if not projects:
                     LOG.warning(f"No project mapping found for VO {vo}")
                 for project in projects:
-                    self.voms_map[project] = vo
+                    voms_map[project] = vo
+            return voms_map
 
     def vm_status(self, status):
         """Return the status corresponding to the OpenStack status.

caso/extract/openstack/base.py

@@ -35,7 +35,12 @@
         "extract records from a specific OpenStack Region, if "
         "there are several defined in the OpenStack site. "
         "Defaults to None.",
-    )
+    ),
+    cfg.StrOpt(
+        "vo_property",
+        default="accounting:VO",
+        help="Property key used to get the VO name from the project properties. ",
+    ),
 ]
 
 CONF.register_opts(opts)
@@ -50,11 +55,11 @@ def __init__(self, project):
         """Initialize the OpenStack extractor for a given project."""
         super(BaseOpenStackExtractor, self).__init__(project)
 
-        self.vo = self._get_vo()
-
         self.keystone = self._get_keystone_client()
         self.project_id = self._get_project_id()
 
+        self.vo = self._get_vo()
+
         class Users:
             def __init__(self, parent):
                 self._users = {}
@@ -111,11 +116,29 @@ def _get_keystone_user(self, uuid):
 
     def _get_vo(self):
         """Get the VO where the project should be mapped."""
-        vo = self.voms_map.get(self.project)
+        project = self.keystone.projects.get(self.project)
+        project.get()
+        vo = project.to_dict().get(CONF.vo_property, None)
         if vo is None:
             LOG.warning(
-                "No mapping could be found for project "
-                f"'{self.project}', please check mapping file!"
+                f"No mapping could be found for project '{self.project}' in the "
+                "Keystone project metadata, please check cASO documentation."
+            )
+            vo = self.voms_map.get(self.project, None)
+            if vo is None:
+                LOG.warning(
+                    "No mapping could be found for project "
+                    f"'{self.project}', please check mapping file!"
+                )
+            else:
+                LOG.warning(
+                    "Using deprecated mapping file, please check cASO documentation "
+                    "and migrate to Keystone properties as soon as possible."
+                )
+        else:
+            LOG.debug(
+                f"Found VO mapping ({vo}) in Keystone project '{self.project}' "
+                "metadata."
             )
         return vo
 

doc/source/configuration.rst

@@ -86,6 +86,17 @@ result from the merge of both methods, so thay are not mutually exclusive.
 * Using the ``projects`` list in the ``[DEFAULT]`` section of your configuration file
   (see below).
 
+Setting VO mapping
+------------------
+
+In order to publish correct accounting records, ``cASO`` needs to know the VO that
+should be used to publish the records from a given project. In order to do so, you need
+to specify the correct mapping in each of the projects properties. The name of the
+property that will be used is defined in the ``vo_property`` configuration option, and
+defaults to ``accounting:VO``, therefore you can configure it as follows::
+
+     openstack project set --property acconting:VO=<VO FQAN> <project id>
+
 cASO configuration
 ==================
 
@@ -128,8 +139,8 @@ of every option. You should check at least the following options:
 
   Note that there might be other messengers available in the system if they are
   registered into the ``caso.messenger`` entry point namespace.
-* ``mapping_file`` (default: ``/etc/caso/voms.json``). File containing the
-  mapping from VOs to local projects as configured in Keystone-VOMS, in the
+* **DEPRECATED** ``mapping_file`` (default: ``/etc/caso/voms.json``). File containing
+  the mapping from VOs to local projects as configured in Keystone-VOMS, in the
   following form::
 
     {

etc/caso/caso.conf.sample

@@ -37,8 +37,13 @@
 # Tag used to mark a project in Keystone to be extracted by cASO (string value)
 #caso_tag = caso
 
-# File containing the VO <-> project mapping as used in Keystone-VOMS. (string
-# value)
+# DEPRECATED: File containing the VO <-> project mapping as used in Keystone-
+# VOMS. (string value)
+# This option is deprecated for removal.
+# Its value may be silently ignored in the future.
+# Reason: This option is marked for removal in the next release. Please see the
+# release notes, and migrate your current configuration to use the
+# project_mapping file as soon as possible.
 #mapping_file = /etc/caso/voms.json
 
 # Extract record changes until this date. If it is not set, we use now. If a

releasenotes/notes/deprecate-voms-mapping-80cfda2246ec43e9.yaml

@@ -0,0 +1,9 @@
+---
+features:
+  - |
+    Allow loading VO mapping directly from Keystone. Instead of mainitaining a 
+    separate file, we now allow users to load the VO directly from a configurable
+    project property.
+deprecations:
+  - |
+    The VO mapping file is now deprecated, in favour of project properties.