Add migrate command to ease migration

Author: alvarolopez

caso/_cmd/projects.py

@@ -22,7 +22,57 @@
 import caso.config
 import caso.manager
 
+cli_opts = [
+    cfg.BoolOpt(
+        "migrate-projects",
+        default=False,
+        help="Migrate also the project list to Keystone tags (i.e. stop using the "
+        "'projects' option in the configuration file).",
+    ),
+]
+
 CONF = cfg.CONF
+CONF.register_cli_opts(cli_opts)
+
+
+def migrate():
+    """Migrate cASO VO file mapping to Keystone-based configuration."""
+    caso.config.parse_args(sys.argv)
+    log.setup(cfg.CONF, "caso")
+
+    CONF.set_default("dry_run", True)
+    manager = caso.manager.Manager()
+    if CONF.dry_run:
+        print(
+            "WARNING: Running in 'dry-run' mode, no actions will be peformed. If you "
+            "want to apply the changes, run with '--nodry-run'. Be aware that in "
+            "that case the cASO user will need write access to Keystone. If unsure "
+            "run the following commands as admin."
+        )
+
+    manager._load_managers()
+    for prj, vo in manager.extractor_manager.voms_map.items():
+        if CONF.dry_run:
+            print(f"openstack project set --property {CONF.vo_property}={vo} {prj}")
+        else:
+            try:
+                kw = {CONF.vo_property: vo}
+                manager.extractor_manager.keystone.projects.update(prj, **kw)
+            except Exception as e:
+                print(f"ERROR: could not add property for project {prj}.")
+                print(f"ERROR: {e}")
+
+    if CONF.migrate_projects:
+        for prj in CONF.projects:
+            if CONF.dry_run:
+                print(f"openstack project set --tag {CONF.caso_tag} {prj}")
+            else:
+                try:
+                    project = manager.extractor_manager.keystone.projects.get(prj)
+                    project.add_tag(CONF.caso_tag)
+                except Exception as e:
+                    print(f"ERROR: could not add tag for project {prj}.")
+                    print(f"ERROR: {e}")
 
 
 def main():

caso/extract/manager.py

@@ -57,7 +57,8 @@
         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.",
+        "to use the new project mapping as soon as possible. If you already migrated "
+        "your configuration, please remove the JSON file to get rid of this message.",
         help="File containing the VO <-> project mapping as used in Keystone-VOMS.",
     ),
     cfg.StrOpt(
@@ -162,6 +163,9 @@ def voms_map(self):
         if self._voms_map:
             return self._voms_map
 
+        if not os.path.exists(CONF.mapping_file):
+            return {}
+
         try:
             mapping = json.loads(open(CONF.mapping_file).read())
         except ValueError:

etc/caso/caso.conf.sample

@@ -46,8 +46,9 @@
 # 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.
+# release notes, and migrate your current configuration to use the new project
+# mapping as soon as possible. If you already migrated your configuration,
+# please remove the JSON file to get rid of this message.
 #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

@@ -7,3 +7,10 @@ features:
 deprecations:
   - |
     The VO mapping file is now deprecated, in favour of project properties.
+upgrade:
+  - | 
+    It is reccomended that you stop using the Keystone voms mapping file as
+    soon as possible, please migrate your old JSON mapping to the new method
+    using Keystone project's properties. In order to do so, you can use the 
+    ``caso-mapping-migrate`` command line option, that will provide you with 
+    the correct commands to run to perform the migration.

setup.cfg

@@ -47,6 +47,7 @@ oslo.config.opts =
 console_scripts =
     caso-extract = caso._cmd.extract:main
     caso-projects = caso._cmd.projects:main
+    caso-mapping-migrate = caso._cmd.projects:migrate
 
 caso.extractors =
     nova = caso.extract.openstack.nova:NovaExtractor