Merge pull request #1055 from douglasjacobsen/base-classes-in-repo

Move base object classes to object repository

Author: douglasjacobsen

etc/ramble/defaults/base_class_repos.yaml

@@ -0,0 +1,14 @@
+# -------------------------------------------------------------------------
+# This is the default ramble repository configuration. It includes the
+# builtin ramble base application repository.
+#
+# Users can override these settings by editing the following files.
+#
+# Per-ramble-instance settings (overrides defaults):
+#   $RAMBLE_ROOT/etc/ramble/base_application_repos.yaml
+#
+# Per-user settings (overrides default and site settings):
+#   ~/.ramble/base_class_repos.yaml
+# -------------------------------------------------------------------------
+base_class_repos:
+  - $ramble/var/ramble/repos/builtin

lib/ramble/ramble/appkit.py

@@ -16,8 +16,11 @@
 from llnl.util.filesystem import *
 
 import ramble.language.application_language
-from ramble.application import ApplicationBase
-from ramble.application_types.executable import ExecutableApplication
+from ramble.repository import get_base_class
+
+ExecutableApplication = get_base_class("executable-application")
+ApplicationBase = get_base_class("application-base")
+
 from ramble.language.application_language import *
 from ramble.language.shared_language import *
 from ramble.spec import Spec

lib/ramble/ramble/application_types/__init__.py

@@ -49,6 +49,7 @@
 import ramble.schema
 import ramble.schema.applications
 import ramble.schema.base_application_repos
+import ramble.schema.base_class_repos
 import ramble.schema.base_modifier_repos
 import ramble.schema.base_package_manager_repos
 import ramble.schema.base_workflow_manager_repos
@@ -102,6 +103,7 @@
     "package_manager_repos": ramble.schema.package_manager_repos.schema,
     "workflow_manager_repos": ramble.schema.workflow_manager_repos.schema,
     "base_application_repos": ramble.schema.base_application_repos.schema,
+    "base_class_repos": ramble.schema.base_class_repos.schema,
     "base_modifier_repos": ramble.schema.base_modifier_repos.schema,
     "base_package_manager_repos": ramble.schema.base_package_manager_repos.schema,
     "base_workflow_manager_repos": ramble.schema.base_workflow_manager_repos.schema,

lib/ramble/ramble/config.py

@@ -96,3 +96,67 @@ class SpecError(RambleError):
 
 class RambleCommandError(Exception):
     """Raised when RambleCommand execution fails."""
+
+
+class ApplicationError(RambleError):
+    """
+    Exception that is raised by applications
+    """
+
+
+class ExecutableNameError(RambleError):
+    """
+    Exception raised when a name collision in executables happens
+    """
+
+
+class FormattedExecutableError(ApplicationError):
+    """
+    Exception raise when there are issues defining formatted executables
+    """
+
+
+class PhaseCycleDetectedError(ApplicationError):
+    """
+    Exception raised when a cycle is detected while ordering phases
+    """
+
+
+class InvalidPhaseError(ApplicationError):
+    """
+    Exception raised when a phase is used but not defined
+    """
+
+
+class ChainCycleDetectedError(ApplicationError):
+    """
+    Exception raised when a cycle is detected in a defined experiment chain
+    """
+
+
+class InvalidChainError(ApplicationError):
+    """
+    Exception raised when a invalid chained experiment is defined
+    """
+
+
+class ObjectValidationError(ApplicationError):
+    """Error when an object validator fails"""
+
+
+class ModifierError(RambleError):
+    """
+    Exception that is raised by modifiers
+    """
+
+
+class InvalidModeError(ModifierError):
+    """
+    Exception raised when an invalid mode is passed
+    """
+
+
+class PackageManagerError(RambleError):
+    """
+    Exception that is raised by package managers
+    """

lib/ramble/ramble/error.py

@@ -33,7 +33,7 @@
     "ramble.package_manager",
     "ramble.wm",
     "ramble.workflow_manager",
-    "ramble.application",
+    "ramble.base_cls",
     "ramble.modifier",
 ]
 

lib/ramble/ramble/language/language_base.py

@@ -13,10 +13,9 @@
 from llnl.util.filesystem import *
 
 import ramble.language.modifier_language
+import ramble.repository
 from ramble.language.modifier_language import *
 from ramble.language.shared_language import *
-from ramble.modifier import ModifierBase
-from ramble.modifier_types.basic import BasicModifier
 from ramble.spec import Spec
 from ramble.util.command_runner import (
     CommandRunner,
@@ -30,3 +29,6 @@
 from ramble.util.logger import logger
 from ramble.util.logger import logger as tty
 from ramble.util.output_capture import OUTPUT_CAPTURE
+
+ModifierBase = ramble.repository.get_base_class("modifier-base")
+BasicModifier = ramble.repository.get_base_class("basic-modifier")

lib/ramble/ramble/modkit.py

@@ -19,9 +19,9 @@
 import llnl.util.tty as tty
 from llnl.util.tty.color import cprint
 
-import ramble.application
 import ramble.config
 import ramble.expander
+import ramble.experiment_result
 import ramble.fetch_strategy
 import ramble.repository
 import ramble.software_environments
@@ -36,6 +36,11 @@
 import spack.util.spack_json as sjson
 from spack.util.executable import Executable, which
 
+ApplicationBase = ramble.repository.get_obj_class(
+    "application-base", object_type=ramble.repository.ObjectTypes.base_classes
+)
+
+
 if not ramble.config.get("config:disable_progress_bar", False):
     try:
         import tqdm
@@ -259,7 +264,7 @@ def _prepare(self):
         no_analyze_cnt = 0
         for _, app_inst, _ in self._experiment_set.filtered_experiments(self.filters):
             if not (app_inst.is_template or app_inst.repeats.is_repeat_base):
-                if app_inst.get_status() != ramble.application.ExperimentStatus.UNKNOWN:
+                if app_inst.get_status() != ramble.experiment_result.ExperimentStatus.UNKNOWN:
                     found_valid_experiment = True
             else:
                 no_analyze_cnt += 1
@@ -369,7 +374,7 @@ def _prepare(self):
 
         excluded_secrets = set()
         if not self.include_secrets:
-            excluded_secrets.add(ramble.application.ApplicationBase.license_inc_name)
+            excluded_secrets.add(ApplicationBase.license_inc_name)
 
         fs.mkdirp(archive_shared)
         for root, _, files in os.walk(self.workspace.shared_dir):

lib/ramble/ramble/pipeline.py

@@ -15,10 +15,11 @@
 from llnl.util.filesystem import *
 
 import ramble.language.package_manager_language
+import ramble.repository
 from ramble.language.package_manager_language import *
 from ramble.language.shared_language import *
-from ramble.package_manager import PackageManagerBase
 from ramble.software_environments import ExternalEnvironment
+from ramble.software_info import SoftwareInfo
 from ramble.spec import Spec
 from ramble.util.command_runner import (
     CommandRunner,
@@ -31,3 +32,5 @@
 from ramble.util.logger import logger
 from ramble.util.logger import logger as tty
 from ramble.util.output_capture import OUTPUT_CAPTURE
+
+PackageManagerBase = ramble.repository.get_base_class("package-manager-base")

lib/ramble/ramble/pkgmankit.py

@@ -62,6 +62,7 @@
         "modifiers",
         "package_managers",
         "workflow_managers",
+        "base_classes",
         "base_applications",
         "base_modifiers",
         "base_package_managers",
@@ -108,6 +109,14 @@
         "accepted_configs": ["workflow_manager_repo.yaml", unified_config],
         "singular": "workflow manager",
     },
+    ObjectTypes.base_classes: {
+        "file_name": "base_class.py",
+        "dir_name": "base_classes",
+        "abbrev": "base_cls",
+        "config_section": "base_class_repos",
+        "accepted_configs": ["base_class_repo.yaml", unified_config],
+        "singular": "base class",
+    },
     ObjectTypes.base_applications: {
         "file_name": "base_application.py",
         "dir_name": "base_applications",
@@ -163,6 +172,11 @@ def _workflow_managers(repo_dirs=None):
     return _gen_path(repo_dirs=repo_dirs, obj_type=ObjectTypes.workflow_managers)
 
 
+def _base_classes(repo_dirs=None):
+    """Get the base classes singleton RepoPath instance for Ramble."""
+    return _gen_path(repo_dirs=repo_dirs, obj_type=ObjectTypes.base_classes)
+
+
 def _base_apps(repo_dirs=None):
     """Get the base applications singleton RepoPath instance for Ramble."""
     return _gen_path(repo_dirs=repo_dirs, obj_type=ObjectTypes.base_applications)
@@ -188,6 +202,7 @@ def _base_workflow_managers(repo_dirs=None):
     ObjectTypes.modifiers: llnl.util.lang.Singleton(_mods),
     ObjectTypes.package_managers: llnl.util.lang.Singleton(_package_managers),
     ObjectTypes.workflow_managers: llnl.util.lang.Singleton(_workflow_managers),
+    ObjectTypes.base_classes: llnl.util.lang.Singleton(_base_classes),
     ObjectTypes.base_applications: llnl.util.lang.Singleton(_base_apps),
     ObjectTypes.base_modifiers: llnl.util.lang.Singleton(_base_mods),
     ObjectTypes.base_package_managers: llnl.util.lang.Singleton(_base_package_managers),
@@ -272,6 +287,16 @@ def get(spec, object_type=default_type):
     return paths[object_type].get(spec)
 
 
+def get_base_class(spec):
+    """Convenience wrapper around ``ramble.repository.get_obj_class()`` for base classes."""
+    return paths[ObjectTypes.base_classes].get_obj_class(spec)
+
+
+def get_obj_class(spec, object_type=default_type):
+    """Convenience wrapper around ``ramble.repository.get_obj_class()``."""
+    return paths[object_type].get_obj_class(spec)
+
+
 def set_path(repo, object_type=default_type):
     """Set the path singleton to a specific value.