Merge pull request #28 from Nike-Inc/devel

Add support for downloading artifacts, deleting jobs, and installing bartlett from homebrew

Author: dogonthehorizon

README.md

@@ -10,13 +10,16 @@ A simple Jenkins command line client to serve your needs.
   - [Supported Platforms](#supported-platforms)
   - [Installation](#installation)
     - [from Homebrew](#from-homebrew)
+      - [Updating Bartlett with Homebrew](#updating-bartlett-with-homebrew)
     - [from Source](#from-source)
   - [Getting Help](#getting-help)
   - [Usage](#usage)
     - [Getting Help at the Command Line](#getting-help-at-the-command-line)
     - [Querying Existing Jobs](#querying-existing-jobs)
     - [Triggering Job Builds](#triggering-job-builds)
     - [Managing Job Configurations](#managing-job-configurations)
+      - [Deleting Existing Jobs](#deleting-existing-jobs)
+    - [Downloading Artifacts for a Given Job](#downloading-artifacts-for-a-given-job)
     - [Configuring Profiles](#configuring-profiles)
       - [Supported Configuration Values](#supported-configuration-values)
         - [A note on password storage](#a-note-on-password-storage)
@@ -76,8 +79,38 @@ please check
 
 ### from Homebrew
 
-Please track the following issue for Homebrew support:
-https://github.com/Nike-Inc/bartlett/issues/4
+Homebrew is an OSX specific application that allows users to install
+applications that didn't come with Apple's operating system.
+
+For help installing Homebrew [see the installation instructions here.](http://brew.sh/)
+
+If you haven't already, be sure to enable Nike's tap:
+
+```
+brew tap nike-inc/nike && brew update
+```
+
+Then install bartlett with the following command:
+
+```
+brew install bartlett
+```
+
+#### Updating Bartlett with Homebrew
+
+Recent versions of Homebrew periodically refresh package indexes, but if you do
+not see the latest version of Bartlett then running the following command
+will force a refresh:
+
+```
+brew update
+```
+
+Then, upgrade to the latest version
+
+```
+brew upgrade bartlett
+```
 
 ### from Source
 
@@ -130,8 +163,9 @@ Available commands:
   info                     Get information on the given job
   build                    Trigger a build for the given job
   config                   Manage XML configurations for jobs
+  artifact                 Download artifacts from jobs
 
-Copyright (c) Nike, Inc. 2016
+Copyright (c) Nike, Inc. 2016-present
 ```
 
 ### Querying Existing Jobs
@@ -251,6 +285,42 @@ Enter password:
 }
 ```
 
+#### Deleting Existing Jobs
+
+You can delete an existing job by passing the `-d` flag to a `config` command:
+
+```
+bartlett --username user --jenkins https://my-jenkins.com \
+  config -d /path/to/job/to/delete
+Enter password:
+{
+    "statusMessage": "OK",
+    "statusCode": 200
+}
+```
+
+### Downloading Artifacts for a Given Job
+
+Artifacts can be downloaded for a given job by using the `artifact` sub-command.
+At this time only one artifcat may be downloaded at a time.
+
+```
+bartlett --username my-user --jenkins https://my-jenkins.com \
+  artifact /path/to/job my-artifact-id
+Enter password:
+echo "foo" > foo.txt
+```
+
+Artifacts are currently sent to STDOUT, which works for simple files, but my not be
+desirable for larger files or binaries. It is recommended at this time to pipe
+artifact output directly to a file:
+
+```
+bartlett --username my-user --jenkins https://my-jenkins.com \
+  artifact /path/to/job my-artifact-id > my-artifact-id.txt
+Enter password:
+```
+
 ### Configuring Profiles
 
 You may store configuration values for many different Jenkins instances. First

app/Main.hs

@@ -8,6 +8,7 @@ import qualified Bartlett.Configuration  as C
 import qualified Bartlett.Actions.Info   as AI
 import qualified Bartlett.Actions.Build  as AB
 import qualified Bartlett.Actions.Config as AC
+import qualified Bartlett.Actions.Artifact as AA
 
 import Control.Exception (bracket_)
 import Data.ByteString.Lazy.Char8 (ByteString, pack, unpack, hPutStr)
@@ -87,12 +88,17 @@ executeCommand cmd usr jenkinsInstance =
       AI.getInfo usr jenkinsInstance jobPaths
     Build jobPath jobParameters ->
       AB.postBuild usr jenkinsInstance jobPath jobParameters
-    Config jobPath configFilePath ->
-      case configFilePath of
-        Just cp ->
-          AC.updateConfig usr jenkinsInstance jobPath cp
-        Nothing ->
-          AC.getConfig usr jenkinsInstance jobPath
+    Artifact jobPath artifactId ->
+      AA.getArtifact usr jenkinsInstance jobPath artifactId
+    Config deleteFlag jobPath configFilePath ->
+      if deleteFlag
+         then AC.deleteConfig usr jenkinsInstance jobPath
+         else
+            case configFilePath of
+              Just cp ->
+                AC.updateConfig usr jenkinsInstance (head jobPath) cp
+              Nothing ->
+                AC.getConfig usr jenkinsInstance (head jobPath)
 
 -- | Execute the appropriate sub-command given parsed cli options.
 run :: Options -> IO ()

bartlett.cabal

@@ -1,5 +1,5 @@
 name:                bartlett
-version:             1.3.1
+version:             1.4.0
 synopsis:            The Jenkins command-line tool to serve your needs.
 description:         Please see README.md
 homepage:            https://github.com/Nike-inc/bartlett
@@ -21,7 +21,8 @@ library
                        Bartlett.Configuration,
                        Bartlett.Actions.Info,
                        Bartlett.Actions.Build,
-                       Bartlett.Actions.Config
+                       Bartlett.Actions.Config,
+                       Bartlett.Actions.Artifact
   ghc-options:
     -fwarn-tabs
     -fwarn-unused-imports

src/Bartlett/Actions/Artifact.hs

@@ -0,0 +1,36 @@
+{-|
+Module      : Info
+Description : Methods for downloading job artifacts from Jenkins
+Copyright   : (c) Nike, Inc., 2016-present
+License     : BSD3
+Maintainer  : fernando.freire@nike.com
+Stability   : stable
+
+Methods for downloading job artifacts from Jenkins.
+-}
+module Bartlett.Actions.Artifact (
+  getArtifact
+) where
+
+import Bartlett.Network (execRequest)
+import Bartlett.Types
+import Bartlett.Util (mkUrl)
+
+import Control.Lens (set, (^.), (&))
+import Data.Maybe (Maybe)
+import qualified Data.ByteString.Lazy.Char8 as BL
+import Network.Wreq (responseBody, defaults, auth)
+
+-- | Download an artifact from the provided job.
+getArtifact ::
+  BasicAuthUser b => Maybe b -- ^ The user to authenticate with.
+  -> JenkinsInstance         -- ^ The Jenkins instance to authenticate against.
+  -> JobPath                 -- ^ The job to get the artifact from.
+  -> ArtifactId              -- ^ The artifact to get from the job.
+  -> IO ()
+getArtifact user base path artifactId = do
+  resp <- execRequest Get reqOpts reqUri Nothing
+  BL.putStrLn $ resp ^. responseBody
+    where reqOpts = defaults & set auth (getBasicAuth <$> user)
+          reqUri  = mkUrl base path $
+                      BL.concat ["/lastSuccessfulBuild/artifact/", artifactId]

src/Bartlett/Actions/Build.hs

@@ -1,7 +1,7 @@
 {-|
 Module      : Build
 Description : Methods for executing build requests against Jenkins
-Copyright   : (c) Nike, Inc., 2016
+Copyright   : (c) Nike, Inc., 2016-present
 License     : BSD3
 Maintainer  : fernando.freire@nike.com
 Stability   : stable

src/Bartlett/Actions/Config.hs

@@ -1,7 +1,7 @@
 {-|
 Module      : Config
 Description : Methods for executing config requests against Jenkins
-Copyright   : (c) Nike, Inc., 2016
+Copyright   : (c) Nike, Inc., 2016-present
 License     : BSD3
 Maintainer  : fernando.freire@nike.com
 Stability   : stable
@@ -48,3 +48,16 @@ updateConfig user base path configPath = do
   resp <- execRequest Post reqOpts (configUri base path) (Just configFile)
   BL.putStrLn . encodePretty . toResponseStatus $ resp ^. responseStatus
     where reqOpts = defaults & set auth (getBasicAuth <$> user)
+
+-- | Delete the XML configuration for the given job.
+deleteConfig :: BasicAuthUser a =>
+  Maybe a              -- The user to authenticate with.
+  -> JenkinsInstance   -- The Jenkins instance to interact with.
+  -> [JobPath]         -- The job for the given Jenkins instance to delete.
+  -> IO ()
+deleteConfig user base [] = return ()
+deleteConfig user base (path:paths) = do
+  resp <- execRequest Post reqOpts (mkUrl base path "/doDelete") Nothing
+  BL.putStrLn . encodePretty . toResponseStatus $ resp ^. responseStatus
+  deleteConfig user base paths
+    where reqOpts = defaults & set auth (getBasicAuth <$> user)

src/Bartlett/Actions/Info.hs

@@ -1,7 +1,7 @@
 {-|
 Module      : Info
 Description : Methods for executing informational requests against Jenkins
-Copyright   : (c) Nike, Inc., 2016
+Copyright   : (c) Nike, Inc., 2016-present
 License     : BSD3
 Maintainer  : fernando.freire@nike.com
 Stability   : stable

src/Bartlett/Configuration.hs

@@ -1,7 +1,7 @@
 {-|
 Module      : Configuration
 Description : Configuration management for Bartlett
-Copyright   : (c) Nike, Inc., 2016
+Copyright   : (c) Nike, Inc., 2016-present
 License     : BSD3
 Maintainer  : fernando.freire@nike.com
 Stability   : stable

src/Bartlett/Network.hs

@@ -3,7 +3,7 @@
 {-|
 Module      : Network
 Description : General network related methods used throughout Bartlett
-Copyright   : (c) Nike, Inc., 2016
+Copyright   : (c) Nike, Inc., 2016-present
 License     : BSD3
 Maintainer  : fernando.freire@nike.com
 Stability   : stable
@@ -20,7 +20,7 @@ module Bartlett.Network (
 )where
 
 import qualified Bartlett.Util as BU
-import           Bartlett.Types (RequestType(Get, Post), JenkinsInstance)
+import           Bartlett.Types (RequestType(..), JenkinsInstance)
 
 import qualified Control.Exception as E
 import           Control.Lens ((.~), (^?), (&))
@@ -31,7 +31,7 @@ import           Data.ByteString.Lazy.Char8 (ByteString, unpack, toStrict)
 import           Data.Maybe (fromMaybe)
 import qualified Network.HTTP.Client as NHC
 import           System.Exit (die)
-import           Network.Wreq (Options, Response, param, responseBody, header, defaults)
+import           Network.Wreq (Options, Response, param, responseBody, header)
 import qualified Network.Wreq.Session as S
 
 
@@ -48,7 +48,7 @@ requestCSRFToken sess opts jenkins = do
     Left _ ->
       return (Nothing, Nothing)
     Right r ->
-      return $
+      return
         (BU.toByteString <$> (r ^? responseBody . key (BU.toText "crumbRequestField") . _String),
          BU.toByteString <$> (r ^? responseBody . key (BU.toText "crumb") . _String))
   where reqUri = BU.setPath jenkins "/crumbIssuer/api/json"

src/Bartlett/Parsers.hs

@@ -1,7 +1,7 @@
 {-|
 Module      : Parsers
 Description : Parsers used to extract command line options at invocation
-Copyright   : (c) Nike, Inc., 2016
+Copyright   : (c) Nike, Inc., 2016-present
 License     : BSD3
 Maintainer  : fernando.freire@nike.com
 Stability   : stable
@@ -39,7 +39,7 @@ withInfo opts desc = info (helper <*> opts)
   (fullDesc
   <> progDesc (unpack desc)
   <> header "bartlett - the Jenkins command-line tool to serve your needs."
-  <> footer "Copyright (c) Nike, Inc. 2016")
+  <> footer "Copyright (c) Nike, Inc. 2016-present")
 
 -- | Parse a credentials flag.
 parseRefreshCredentials :: Parser Bool
@@ -77,6 +77,12 @@ parseConfigFilePath = option str $
   short 'f' <> long "filepath" <> metavar "CONFIG_FILE_PATH" <>
   help "Path to the job configuration to upload"
 
+-- | Parse whether we should delete the given resource.
+parseDeleteFlag :: Parser DeleteFlag
+parseDeleteFlag = switch $
+  short 'd' <> long "delete"
+  <> help "Delete the given job path"
+
 -- | Parse an Info sub-command.
 parseInfo :: Parser Command
 parseInfo = Info <$> some (argument readerByteString (metavar "JOB_PATHS..."))
@@ -90,15 +96,23 @@ parseBuild = Build
 -- | Parse a Config sub-command.
 parseConfig :: Parser Command
 parseConfig = Config
-  <$> argument readerByteString (metavar "JOB_PATH")
+  <$> parseDeleteFlag
+  <*> some (argument readerByteString (metavar "JOB_PATH..."))
   <*> optional parseConfigFilePath
 
+-- | Parse an Artifact sub-command.
+parseArtifact :: Parser Command
+parseArtifact = Artifact
+  <$> argument readerByteString (metavar "JOB_PATH")
+  <*> argument readerByteString (metavar "ARTIFACT_ID")
+
 -- | Parse a Command.
 parseCommand :: Parser Command
 parseCommand = subparser $
   command "info" (parseInfo `withInfo` "Get information on the given job")
   <> command "build" (parseBuild `withInfo` "Trigger a build for the given job")
   <> command "config" (parseConfig `withInfo` "Manage XML configurations for jobs")
+  <> command "artifact" (parseArtifact `withInfo` "Download artifacts from jobs")
 
 -- | Combinator for all command line options.
 parseOptions :: Parser Options