Source code for mac_maker.jobs.github

"""A provisioning job for a Profile in a Github Repository."""

from typing import Optional

import click
from .. import config
from ..utilities.github import GithubRepository
from ..utilities.precheck import TypePrecheckFileData
from ..utilities.spec import TypeSpecFileData
from ..utilities.state import TypeState
from ..utilities.workspace import WorkSpace
from . import bases


class GitHubJob(bases.ProvisionerJobBase):
  """A provisioning job for a Profile in a Github Repository.

  :param repository_url: The GitHub Repository URL.
  :param branch_name: The GitHub Repository branch name.
  """

  repository_url: str
  branch_name: Optional[str]
  workspace: Optional[WorkSpace]
  loaded_spec_file_data: TypeSpecFileData

  def __init__(self, repository_url: str, branch_name: Optional[str]):
    super().__init__()
    self.branch_name = branch_name
    self.repository = GithubRepository(repository_url)
    self.workspace = None

  def _initialize_workspace(self) -> None:
    if self.workspace:
      return

    click.echo(config.ANSIBLE_RETRIEVE_MESSAGE)

    self.workspace = WorkSpace()
    self.workspace.add_repository(self.repository, self.branch_name)
    self.workspace.add_spec_file()
    self.loaded_spec_file_data = self.jobspec_extractor.get_job_spec_data(
        str(self.workspace.spec_file)
    )

  def get_precheck_content(self) -> TypePrecheckFileData:
    """Read the Precheck data from a GitHub Repository.

    :returns: The Precheck file data.
    """

    self._initialize_workspace()
    precheck_data = self.precheck_extractor.get_precheck_data(
        self.loaded_spec_file_data
    )
    return precheck_data

  def get_state(self) -> TypeState:
    """Fetch a GitHub zip bundle, and build a runtime state object.

    :returns: The created runtime state object.
    """

    self._initialize_workspace()
    click.echo(config.ANSIBLE_JOB_SPEC_MESSAGE)
    click.echo(self.loaded_spec_file_data['spec_file_location'])
    return self.loaded_spec_file_data['spec_file_content']