Moved web application context file.

The location of web application context file has been changed from
  <instance>/webapps/<name>/META-INF/context.xml
into
  <instance>/conf/Catalina/localhost/<name>.xml.
This will eventually allow deploying the web application directly
from the shared folder.

A new upgrade script has been added to move the context files in
the existing instances.

Ticket #499

2 files changed, 79 insertions, 86 deletions

diff --git a/base/server/python/pki/server/deployment/scriptlets/instance_layout.py b/base/server/python/pki/server/deployment/scriptlets/instance_layout.py
index 6ca9a374d..86968e22e 100644
--- a/base/server/python/pki/server/deployment/scriptlets/instance_layout.py
+++ b/base/server/python/pki/server/deployment/scriptlets/instance_layout.py
@@ -39,18 +39,22 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
             config.pki_log.info(log.SKIP_INSTANCE_SPAWN_1, __name__,
                                 extra=config.PKI_INDENTATION_LEVEL_1)
             return self.rv
+
         config.pki_log.info(log.INSTANCE_SPAWN_1, __name__,
                             extra=config.PKI_INDENTATION_LEVEL_1)
-        # establish instance logs
-        deployer.directory.create(deployer.master_dict['pki_instance_log_path'])
-        # establish instance configuration
-        deployer.directory.create(deployer.master_dict['pki_instance_configuration_path'])
-        # establish Apache/Tomcat specific instance
-        if deployer.master_dict['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS:
+
+        # if this is the first subsystem
+        if deployer.master_dict['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS and\
+            len(deployer.instance.tomcat_instance_subsystems()) == 1:
+
+            # establish instance logs
+            deployer.directory.create(deployer.master_dict['pki_instance_log_path'])
+
             # establish Tomcat instance configuration
-            deployer.directory.copy(deployer.master_dict['pki_source_server_path'],
-                                deployer.master_dict['pki_instance_configuration_path'],
-                                overwrite_flag=True)
+            deployer.directory.copy(
+                deployer.master_dict['pki_source_server_path'],
+                deployer.master_dict['pki_instance_configuration_path'])
+
             # establish Tomcat instance base
             deployer.directory.create(deployer.master_dict['pki_tomcat_common_path'])
             deployer.directory.create(deployer.master_dict['pki_tomcat_common_lib_path'])
@@ -67,7 +71,27 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
             deployer.symlink.create(deployer.master_dict['pki_instance_conf_log4j_properties'],
                                 deployer.master_dict['pki_instance_lib_log4j_properties'])
             deployer.directory.create(deployer.master_dict['pki_tomcat_tmpdir_path'])
-            deployer.directory.create(deployer.master_dict['pki_tomcat_webapps_path'])
+
+            # Copy /usr/share/pki/server/webapps to <instance>/webapps
+            deployer.directory.copy(
+                os.path.join(
+                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
+                    "server",
+                    "webapps"),
+                deployer.master_dict['pki_tomcat_webapps_path'])
+
+            # If desired and available,
+            # copy selected server theme
+            # to <instance>/webapps/pki
+            if config.str2bool(deployer.master_dict['pki_theme_enable']) and\
+                os.path.exists(deployer.master_dict['pki_theme_server_dir']):
+                deployer.directory.copy(
+                    deployer.master_dict['pki_theme_server_dir'],
+                    os.path.join(
+                        deployer.master_dict['pki_tomcat_webapps_path'],
+                        "pki"),
+                    overwrite_flag=True)
+
             deployer.directory.create(deployer.master_dict['pki_tomcat_work_path'])
             deployer.directory.create(deployer.master_dict['pki_tomcat_work_catalina_path'])
             deployer.directory.create(deployer.master_dict['pki_tomcat_work_catalina_host_path'])
@@ -120,9 +144,6 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
                 deployer.master_dict['pki_resteasy_jettison_provider_jar_link'])
             deployer.symlink.create(deployer.master_dict['pki_scannotation_jar'],
                 deployer.master_dict['pki_scannotation_jar_link'])
-            if deployer.master_dict['pki_subsystem'] == 'TKS':
-                deployer.symlink.create(deployer.master_dict['pki_symkey_jar'],
-                    deployer.master_dict['pki_symkey_jar_link'])
             deployer.symlink.create(deployer.master_dict['pki_tomcatjss_jar'],
                 deployer.master_dict['pki_tomcatjss_jar_link'])
             deployer.symlink.create(deployer.master_dict['pki_velocity_jar'],
@@ -133,23 +154,31 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
                 deployer.master_dict['pki_xml_commons_apis_jar_link'])
             deployer.symlink.create(deployer.master_dict['pki_xml_commons_resolver_jar'],
                 deployer.master_dict['pki_xml_commons_resolver_jar_link'])
-        # establish shared NSS security databases for this instance
-        deployer.directory.create(deployer.master_dict['pki_database_path'])
-        # establish instance convenience symbolic links
-        deployer.symlink.create(deployer.master_dict['pki_database_path'],
+
+            # establish shared NSS security databases for this instance
+            deployer.directory.create(deployer.master_dict['pki_database_path'])
+            # establish instance convenience symbolic links
+            deployer.symlink.create(deployer.master_dict['pki_database_path'],
                             deployer.master_dict['pki_instance_database_link'])
-        deployer.symlink.create(deployer.master_dict['pki_instance_configuration_path'],
+            deployer.symlink.create(deployer.master_dict['pki_instance_configuration_path'],
                             deployer.master_dict['pki_instance_conf_link'])
-        deployer.symlink.create(deployer.master_dict['pki_instance_log_path'],
+            deployer.symlink.create(deployer.master_dict['pki_instance_log_path'],
                             deployer.master_dict['pki_instance_logs_link'])
+
+        if deployer.master_dict['pki_subsystem'] == 'TKS':
+            deployer.symlink.create(deployer.master_dict['pki_symkey_jar'],
+                deployer.master_dict['pki_symkey_jar_link'])
+
         return self.rv
 
     def destroy(self, deployer):
 
         config.pki_log.info(log.INSTANCE_DESTROY_1, __name__,
                             extra=config.PKI_INDENTATION_LEVEL_1)
+
         if deployer.master_dict['pki_subsystem'] == 'TKS':
             deployer.symlink.delete(deployer.master_dict['pki_symkey_jar_link'])
+
         if deployer.master_dict['pki_subsystem'] in config.PKI_APACHE_SUBSYSTEMS and\
            deployer.instance.apache_instance_subsystems() == 0:
             # remove Apache instance base
@@ -165,6 +194,7 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
             if deployer.instance.apache_instances() == 0:
                 deployer.directory.delete(
                     deployer.master_dict['pki_instance_type_registry_path'])
+
         elif deployer.master_dict['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS and\
              len(deployer.instance.tomcat_instance_subsystems()) == 0:
             # remove Tomcat instance base
@@ -183,4 +213,5 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
             if deployer.instance.tomcat_instances() == 0:
                 deployer.directory.delete(
                     deployer.master_dict['pki_instance_type_registry_path'])
+
         return self.rv
diff --git a/base/server/python/pki/server/deployment/scriptlets/webapp_deployment.py b/base/server/python/pki/server/deployment/scriptlets/webapp_deployment.py
index ccbf4ea90..70f2ccc88 100644
--- a/base/server/python/pki/server/deployment/scriptlets/webapp_deployment.py
+++ b/base/server/python/pki/server/deployment/scriptlets/webapp_deployment.py
@@ -40,76 +40,10 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
                                      __name__,
                                     extra=config.PKI_INDENTATION_LEVEL_1)
                 return self.rv
+
             config.pki_log.info(log.WEBAPP_DEPLOYMENT_SPAWN_1, __name__,
                                 extra=config.PKI_INDENTATION_LEVEL_1)
 
-            # Copy /usr/share/pki/server/webapps/ROOT
-            # to <instance>/webapps/ROOT
-            deployer.directory.create(deployer.master_dict['pki_tomcat_webapps_root_path'])
-            deployer.directory.copy(
-                os.path.join(
-                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
-                    "server",
-                    "webapps",
-                    "ROOT"),
-                deployer.master_dict['pki_tomcat_webapps_root_path'],
-                overwrite_flag=True)
-
-            deployer.directory.create(deployer.master_dict['pki_tomcat_webapps_common_path'])
-
-            # If desired and available,
-            # copy selected server theme
-            # to <instance>/webapps/pki
-            if config.str2bool(deployer.master_dict['pki_theme_enable']) and\
-               os.path.exists(deployer.master_dict['pki_theme_server_dir']):
-                deployer.directory.copy(deployer.master_dict['pki_theme_server_dir'],
-                                    deployer.master_dict['pki_tomcat_webapps_common_path'],
-                                    overwrite_flag=True)
-
-            # Copy /usr/share/pki/server/webapps/pki/js
-            # to <instance>/webapps/pki/js
-            deployer.directory.copy(
-                os.path.join(
-                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
-                    "server",
-                    "webapps",
-                    "pki",
-                    "js"),
-                os.path.join(
-                    deployer.master_dict['pki_tomcat_webapps_common_path'],
-                    "js"),
-                overwrite_flag=True)
-
-            # Copy /usr/share/pki/server/webapps/pki/META-INF
-            # to <instance>/webapps/pki/META-INF
-            deployer.directory.copy(
-                os.path.join(
-                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
-                    "server",
-                    "webapps",
-                    "pki",
-                    "META-INF"),
-                os.path.join(
-                    deployer.master_dict['pki_tomcat_webapps_common_path'],
-                    "META-INF"),
-                overwrite_flag=True)
-
-            # Copy /usr/share/pki/server/webapps/pki/admin
-            # to <instance>/webapps/<subsystem>/admin
-            # TODO: common templates should be deployed in common webapp
-            deployer.directory.create(deployer.master_dict['pki_tomcat_webapps_subsystem_path'])
-            deployer.directory.copy(
-                os.path.join(
-                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
-                    "server",
-                    "webapps",
-                    "pki",
-                    "admin"),
-                os.path.join(
-                    deployer.master_dict['pki_tomcat_webapps_subsystem_path'],
-                    "admin"),
-                overwrite_flag=True)
-
             # Copy /usr/share/pki/<subsystem>/webapps/<subsystem>
             # to <instance>/webapps/<subsystem>
             deployer.directory.copy(
@@ -155,11 +89,39 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
                                     deployer.master_dict['pki_tps_jar_link'])
             # set ownerships, permissions, and acls
             deployer.directory.set_mode(deployer.master_dict['pki_tomcat_webapps_subsystem_path'])
+
+            # Copy /usr/share/pki/<subsystem>/conf/Catalina/localhost/<subsystem>.xml
+            # to <instance>/conf/Catalina/localhost/<subsystem>.xml
+            deployer.file.copy(
+                os.path.join(
+                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
+                    deployer.master_dict['pki_subsystem'].lower(),
+                    "conf",
+                    "Catalina",
+                    "localhost",
+                    deployer.master_dict['pki_subsystem'].lower() + ".xml"),
+                os.path.join(
+                    deployer.master_dict['pki_instance_configuration_path'],
+                    "Catalina",
+                    "localhost",
+                    deployer.master_dict['pki_subsystem'].lower() + ".xml"))
+
         return self.rv
 
     def destroy(self, deployer):
         if deployer.master_dict['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS:
             config.pki_log.info(log.WEBAPP_DEPLOYMENT_DESTROY_1, __name__,
                                 extra=config.PKI_INDENTATION_LEVEL_1)
+
+            # Delete <instance>/conf/Catalina/localhost/<subsystem>.xml
+            deployer.file.delete(
+                os.path.join(
+                    deployer.master_dict['pki_instance_configuration_path'],
+                    "Catalina",
+                    "localhost",
+                    deployer.master_dict['pki_subsystem'].lower() + ".xml"))
+
+            # Delete <instance>/webapps/<subsystem>
             deployer.directory.delete(deployer.master_dict['pki_tomcat_webapps_subsystem_path'])
+
         return self.rv