Workflow.hs

module Hydra.Sources.Workflow where

-- Standard imports for type-level sources outside of the kernel
import           Hydra.Kernel
import           Hydra.Dsl.Annotations (doc)
import           Hydra.Dsl.Bootstrap
import           Hydra.Dsl.Types ((>:), (@@), (~>))
import qualified Hydra.Dsl.Types as T
import qualified Hydra.Sources.Kernel.Types.Core as Core
import qualified Hydra.Sources.Kernel.Types.Graph as Graph
import qualified Hydra.Sources.Kernel.Types.Packaging as Module


ns :: Namespace
ns = Namespace "hydra.workflow"

define :: String -> Type -> Binding
define = defineType ns

module_ :: Module
module_ = Module {
            moduleNamespace = ns,
            moduleDefinitions = (map toTypeDef definitions),
            moduleTermDependencies = [Graph.ns, Module.ns],
            moduleTypeDependencies = [Core.ns],
            moduleDescription = Just "A model for Hydra transformation workflows"}
  where
    definitions = [
      hydraSchemaSpec,
      schemaSpec,
      transformWorkflow]

hydraSchemaSpec :: Binding
hydraSchemaSpec = define "HydraSchemaSpec" $
  doc "The specification of a Hydra schema, provided as a set of modules and a distinguished type" $
  T.record [
    "modules">:
      doc "The modules to include in the schema graph" $
      T.list Module.module',
    "typeName">:
      doc "The name of the top-level type; all data which passes through the workflow will be instances of this type"
      Core.name]

schemaSpec :: Binding
schemaSpec = define "SchemaSpec" $
  doc "The specification of a schema at the source end of a workflow" $
  T.union [
    "hydra">:
      doc "A native Hydra schema"
      hydraSchemaSpec,
    "file">:
      doc "A schema provided as a file, available at the given file path" $
      T.string,
    "provided">:
      doc "A schema which will be provided within the workflow" $
      T.unit]

transformWorkflow :: Binding
transformWorkflow = define "TransformWorkflow" $
  doc "The specification of a workflow which takes a schema specification, reads data from a directory, and writes data to another directory" $
  T.record [
    "name">:
      doc "A descriptive name for the workflow" $
      T.string,
    "schemaSpec">:
      doc "The schema specification"
      schemaSpec,
    "srcDir">:
      doc "The source directory" $
      T.string,
    "destDir">:
      doc "The destination directory" $
      T.string]