{-# LANGUAGE OverloadedStrings #-}

-- |
-- Module      : Jobs
-- Description : Queries about jobs ran on projects
-- Copyright   : (c) Rob Stewart, Heriot-Watt University, 2019
-- License     : BSD3
-- Maintainer  : robstewart57@gmail.com
-- Stability   : stable
module GitLab.API.Jobs
  ( -- * List project jobs
    jobs,

    -- * List pipeline jobs
    pipelineJobs,

    -- * List pipeline bridges
    pipelineBridges,

    -- * Get a single job
    job,

    -- * Cancel a job
    cancelJob,

    -- * Retry a job
    retryJob,

    -- * Erase a job
    eraseJob,

    -- * Run a job
    runJob,
  )
where

import Control.Monad.Except
import qualified Data.ByteString.Lazy as BSL
import qualified Data.Text as T
import GitLab.Types
import GitLab.WebRequests.GitLabWebCalls
import Network.HTTP.Client

-- | returns all jobs ran on a project.
jobs ::
  -- | the project
  Project ->
  GitLab [Job]
jobs :: Project -> GitLab [Job]
jobs Project
project = do
  Either (Response ByteString) [Job]
result <- Int -> GitLab (Either (Response ByteString) [Job])
jobs' (Project -> Int
project_id Project
project)
  case Either (Response ByteString) [Job]
result of
    Left Response ByteString
er -> GitLabError -> GitLab [Job]
forall a. GitLabError -> GitLabT (ExceptT GitLabError IO) a
forall e (m :: * -> *) a. MonadError e m => e -> m a
throwError (Text -> GitLabError
GitLabError (Text
"jobs error: " Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Response ByteString -> Text
forall payload. Response payload -> Text
responseErrorText Response ByteString
er))
    Right [Job]
answer -> [Job] -> GitLab [Job]
forall a. a -> GitLabT (ExceptT GitLabError IO) a
forall (m :: * -> *) a. Monad m => a -> m a
return [Job]
answer

-- | Get a list of jobs in a project. Jobs are sorted in descending
-- order of their IDs.
jobs' ::
  -- | the project ID
  Int ->
  GitLab (Either (Response BSL.ByteString) [Job])
jobs' :: Int -> GitLab (Either (Response ByteString) [Job])
jobs' Int
projectId =
  Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) [Job])
forall a.
FromJSON a =>
Text -> [GitLabParam] -> GitLab (Either (Response ByteString) [a])
gitlabGetMany Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
projectId)
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/jobs"

-- | Get a list of jobs for a pipeline.
pipelineJobs ::
  -- | the project
  Project ->
  -- | pipeline ID
  Int ->
  GitLab (Either (Response BSL.ByteString) [Job])
pipelineJobs :: Project -> Int -> GitLab (Either (Response ByteString) [Job])
pipelineJobs Project
prj Int
pipelineId =
  Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) [Job])
forall a.
FromJSON a =>
Text -> [GitLabParam] -> GitLab (Either (Response ByteString) [a])
gitlabGetMany Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show (Project -> Int
project_id Project
prj))
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/pipelines/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
pipelineId)
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/jobs"

-- | Get a list of bridge jobs for a pipeline.
pipelineBridges ::
  -- | the project
  Project ->
  -- | pipeline ID
  Int ->
  GitLab (Either (Response BSL.ByteString) [Job])
pipelineBridges :: Project -> Int -> GitLab (Either (Response ByteString) [Job])
pipelineBridges Project
prj Int
pipelineId =
  Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) [Job])
forall a.
FromJSON a =>
Text -> [GitLabParam] -> GitLab (Either (Response ByteString) [a])
gitlabGetMany Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show (Project -> Int
project_id Project
prj))
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/pipelines/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
pipelineId)
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/bridges"

-- | Get a single job of a project.
job ::
  -- | the project
  Project ->
  -- | job ID
  Int ->
  GitLab (Either (Response BSL.ByteString) (Maybe Job))
job :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe Job))
job Project
prj Int
jobId =
  Text
-> [GitLabParam]
-> GitLab (Either (Response ByteString) (Maybe Job))
forall a.
FromJSON a =>
Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) (Maybe a))
gitlabGetOne Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show (Project -> Int
project_id Project
prj))
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/jobs/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
jobId)

-- | Cancel a single job of a project.
cancelJob ::
  -- | the project
  Project ->
  -- | job ID
  Int ->
  GitLab (Either (Response BSL.ByteString) (Maybe Job))
cancelJob :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe Job))
cancelJob Project
prj Int
jobId =
  Text
-> [GitLabParam]
-> GitLab (Either (Response ByteString) (Maybe Job))
forall a.
FromJSON a =>
Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) (Maybe a))
gitlabPost Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show (Project -> Int
project_id Project
prj))
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/jobs/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
jobId)
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/cancel"

-- | Retry a single job of a project.
retryJob ::
  -- | the project
  Project ->
  -- | job ID
  Int ->
  GitLab (Either (Response BSL.ByteString) (Maybe Job))
retryJob :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe Job))
retryJob Project
prj Int
jobId =
  Text
-> [GitLabParam]
-> GitLab (Either (Response ByteString) (Maybe Job))
forall a.
FromJSON a =>
Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) (Maybe a))
gitlabPost Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show (Project -> Int
project_id Project
prj))
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/jobs/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
jobId)
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/cancel"

-- | Erase a single job of a project.
eraseJob ::
  -- | the project
  Project ->
  -- | job ID
  Int ->
  GitLab (Either (Response BSL.ByteString) (Maybe Job))
eraseJob :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe Job))
eraseJob Project
prj Int
jobId =
  Text
-> [GitLabParam]
-> GitLab (Either (Response ByteString) (Maybe Job))
forall a.
FromJSON a =>
Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) (Maybe a))
gitlabPost Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show (Project -> Int
project_id Project
prj))
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/jobs/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
jobId)
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/erase"

-- | Triggers a manual action to start a job.
runJob ::
  -- | the project
  Project ->
  -- | job ID
  Int ->
  GitLab (Either (Response BSL.ByteString) (Maybe Job))
runJob :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe Job))
runJob Project
prj Int
jobId =
  Text
-> [GitLabParam]
-> GitLab (Either (Response ByteString) (Maybe Job))
forall a.
FromJSON a =>
Text
-> [GitLabParam] -> GitLab (Either (Response ByteString) (Maybe a))
gitlabPost Text
addr []
  where
    addr :: Text
addr =
      Text
"/projects/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show (Project -> Int
project_id Project
prj))
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/jobs/"
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> String -> Text
T.pack (Int -> String
forall a. Show a => a -> String
show Int
jobId)
        Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"/play"