nike-inc / bartlett Goto Github PK

As a bartlett user, I would like to be able to download artifacts by id, so that I can manipulate them from my local machine.

AC:

• Bartlett can download artifacts for a given job by id

As a Bartlett user I would like to be able to display the currently running build queue of my Jenkins instance, so that I can have an accurate snapshot of the Jenkins server.

AC:

• when no options are given, the user is given a JSON representation of the build queue
• when the streaming option is given, the user is presented with a refreshing textual display of the build queue

As a Bartlett user I would like the ability to delete jobs, so that I can keep my Jenkins tidy.

AC:

• user can delete a single job given a job path
• user can delete a folder given a job path
• user can delete many jobs given 1+ paths

As a Bartlett user I would like to filter the depth and trees of my responses, so that only relevant information is returned from my requests to Jenkins.

AC:

• user can specify depth of responses
• user can specify sub-trees of responses
• user can specify default depth and tree options in profile configuration

The current documentation doesn't make it explicit that passing -f to the config sub-command will update a job. Clean this up a bit!

As a Bartlett developer, I want a Travis build for Bartlett, so that I can reliably build, deploy, and test Bartlett.

AC:

• Automated build in Travis
• Configure build to run on each Pull Request
• Build runs test suite for Bartlett
• Build produces static binary for Bartlett

As a Bartlett user on OSX, I want a simple way to install Bartlett, so that I don't have to manage build tools or development environments to run Bartlett.

AC:

• Upstream Homebrew project has a Formula for Bartlett
• Formula sources built binary from configured bin storage solution defined in #3
• README is updated to point to new Homebrew installation source

Since moving to hpack the release task is no longer correct; it should be looking for the version of the application form package.yaml instead of bartlett.cabal.

As a Bartlett user, I would like to know what version of Bartlett I am currently using, so that I know what featureset I have and when I should upgrade my installed version.

AC:

• Bartlett can report its own version using the --version flag
• Bartlett reports its version as part of the provided help message

This ticket is simply to track porting the Bartlett tool to the Windows platform while maintaining feature parity with the OSX platform version of the tool.

One thing to note about Windows support is finding an adequate credentials store. I'm not aware of anything native to Windows like OSX's Keychain. It could also mean that credentials caching is not supported if a happy medium can't be found!

Currently you can browse the root tree by executing
bartlett info /

However it seems you can't do the same on a subtree
bartlett info /folder/ or bartlett info /folder/folder/

Can we allow the same type of listing that is done for the subtree if it ends in a forward slash as we do for the root folder?

As a Bartlett developer, I want some means to mock Jenkins API responses, so that I can unit test my IO actions and have greater confidence in the codebase.

This could also be accomplished by running the tests in a Docker container with a running Jenkins instance. This may or may not be more work.

AC:

• tests written against Build and Info actions
• tests can be run locally without an internet connection

As a Bartlett user, I would like to supply job parameters from a file, so that I can reduce the tedium of typing all options out for a job on each invocation.

AC:

• Bartlett build command accepts a properties file instead of the -o flag

If the user fails to authenticate to Jenkins the credentials will still be stored in the Keychain. Expected behavior is that the credentials are not cached, or if they are, that there is a cli option to re-cache credentials.

This ticket is simply to track porting the Bartlett tool to the GNU/Linux family of operating systems while maintaining feature parity with the OSX platform version of the tool.

There's a bevy of credentials store options on Linux. The currently library supports KWallet, but there's potential to support more offerings in the future. It could also mean that credentials caching is not supported if a happy medium can't be found!

Bartlett fails to omit the CSRF crumb header if it is not enabled on the target Jenkins server. This means that any authenticated action will fail with a mysterious 400 BAD REQUEST error.

from command line, we can disable a bunch of jobs.

As a Bartlett user I want to be aware of the gotchas when entering a URL to my Jenkins instance, so that I can make informed decisions about how I configure Bartlett.

AC:

• Should inform the user that omitting the protocol leads to undefined behavior
• Should inform the user that protocol specification is always recommended

As a bartlett user I want to read API documentation in my browser, so that I do not have to compile the project from source to access this documentation.

AC:

• Automated documentation generation and hosting

As a Bartlett user, I would like the tool to support CSRF crumb generation, so that I can securely upload data to my Jenkins instance.

AC:

• All POST requests to Jenkins first attempt to generate a CSRF crumb before posting data.

As a user, I'd like to pass in my credentials at invocation time, so that I do not have to store them locally or input them manually at runtime.

As a Bartlett user, I would like to stream log output directly from the build sub-command, so that I do not have to execute a second log sub-command when triggering jobs in order to stream log output.

AC:

• Flag added (-f|--follow) to build sub-command to stream log output

current one can only update

As a Bartlett user, if I have not specified a protocol at invocation, I want my requests to be resolved via SSL before they are attempted over HTTP, so that my user credentials are not sent in the clear.

AC:

• If protocol is specified (http or https), make requests over the given protocol
• If no protocol is specified, attempt the request over SSL before using HTTP

As a bartlett user, I would like to download the config.xml for a given job, so that I can debug the output of my generated jobs.

AC:

• Bartlett can download config.xml for a given job.

As a Bartlett user, I would like to stream job output from a running or triggered job, so that I can monitor the progress of my job from the command line.

AC:

• log sub-command added to print completed job's log given job path and build number
• log sub-command has flag -f|--follow that follows Jenkins log output for a running job given job path

As a Bartlett user, I would like the option to enable colors in log output if the upstream job has enabled them, so that I can easily distinguish events in my builds.

Notes:

• I'm not actually sure if this is currently possible. It may require parsing the HTML endpoint instead of the progressive text endpoint to access these colors.

AC:

• log and build sub-commands support option to display log output with colors

so we can use to get all jobs and back them up.