# Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os
import shutil
import traceback
from typing import List, Optional
from .constants import CtxKey, ProvisionMode, WorkDir
from .ctx import ProvisionContext
from .entity import Project
from .spec import Builder, Packager
[docs]
class Provisioner:
def __init__(self, root_dir: str, builders: List[Builder], packager: Optional[Packager] = None):
"""Workflow class that drive the provision process.
Provisioner's tasks:
- Maintain the provision workspace folder structure;
- Invoke Builders to generate the content of each startup kit
ROOT_WORKSPACE Folder Structure::
root_workspace_dir_name: this is the root of the workspace
project_dir_name: the root dir of the project, could be named after the project
resources: stores resource files (templates, configs, etc.) of the Provisioner and Builders
prod: stores the current set of startup kits (production)
participate_dir: stores content files generated by builders
wip: stores the set of startup kits to be created (WIP)
participate_dir: stores content files generated by builders
state: stores the persistent state of the Builders
Args:
root_dir (str): the directory path to hold all generated or intermediate folders
builders (List[Builder]): all builders that will be called to build the content
"""
self.root_dir = root_dir
self.builders = builders
self.packager = packager
self.template = {}
if not builders:
raise ValueError("no builders are provided")
for b in builders:
if not isinstance(b, Builder):
raise ValueError(f"builders must all be Builder type but got {type(b)}")
if packager:
if not isinstance(packager, Packager):
raise ValueError(f"packager must be Packager type but got {type(packager)}")
[docs]
def add_template(self, template: dict):
if not isinstance(template, dict):
raise ValueError(f"template must be a dict but got {type(template)}")
self.template.update(template)
@staticmethod
def _check_method(logger, method_name: str):
if not hasattr(logger, method_name):
raise ValueError(f"invalid logger {type(logger)}: missing method '{method_name}'")
elif not callable(getattr(logger, method_name)):
raise ValueError(f"invalid logger {type(logger)}: method '{method_name}' is not callable")
[docs]
def provision(self, project: Project, mode=None, logger=None) -> ProvisionContext:
"""Provision a specified project.
Args:
project: the project to be provisioned.
mode: provision mode: either "poc" or "normal". If not specified, default to "normal".
logger: a logger object to be used for message logging. If not specified, default to print.
The logger must implement 4 methods: debug, info, warning, error.
The logger object does NOT have to be based on logging.Logger. It could be used for
collecting information into memory and displayed to end user at the end of provision.
Returns: a ProvisionContext that contains properties created during provision, especially a
property (CtxKey.CURRENT_PROD_DIR) that specifies where the provision result is stored.
"""
ctx = self._build(project, mode, logger)
if self.packager and not ctx.get(CtxKey.BUILD_ERROR):
self.packager.package(project, ctx)
return ctx
def _build(self, project: Project, mode=None, logger=None) -> ProvisionContext:
if logger:
self._check_method(logger, "info")
self._check_method(logger, "debug")
self._check_method(logger, "warning")
self._check_method(logger, "error")
server = project.get_server()
if not server:
raise RuntimeError("missing server from the project")
workspace_root_dir = os.path.join(self.root_dir, project.name)
ctx = ProvisionContext(workspace_root_dir, project)
if not mode:
mode = ProvisionMode.NORMAL
valid_modes = [ProvisionMode.NORMAL, ProvisionMode.POC]
if mode not in valid_modes:
raise ValueError(f"invalid mode '{mode}': must be one of {valid_modes}")
ctx.set_provision_mode(mode)
if logger:
ctx.set_logger(logger)
try:
for b in self.builders:
b.initialize(project, ctx)
# call builders!
for b in self.builders:
b.build(project, ctx)
for b in self.builders[::-1]:
b.finalize(project, ctx)
except Exception as ex:
prod_dir = ctx.get(WorkDir.CURRENT_PROD_DIR)
if prod_dir:
shutil.rmtree(prod_dir)
ctx.error(f"Exception {ex} raised during provision. Incomplete prod_n folder removed.")
traceback.print_exc()
ctx[CtxKey.BUILD_ERROR] = True
finally:
wip_dir = ctx.get(WorkDir.WIP)
if wip_dir:
shutil.rmtree(wip_dir)
return ctx