/jenkins

Primary LanguageGroovy

Welcome

Overview

This archive contains files for our basic Jenkins pipeline to automatically create MySQL database instance - running on Docker, so our developers can have their very own environment to use.

This archive contains all the files being used by the current version of the pipeline.

|-- Dockerfile
|-- build-dev-environment.groovy
`-- include
    `-- create_developer.template

Preparation

  • Please upload your solution to GitHub into a public repository and share the URL in reply e-mail

Expected behaviour

  • Developers can trigger the pipeline with parameters (Environment name, MySQL password and MySQL port)
  • A docker image built from latest MySQL image
  • Spin up a container from the image built above, exposing the requested port on the Docker host
  • Prepare the environment by creating an account for the developer (username: developer, password: based on input parameter)

Issues

  • The pipeline fails randomly in Jenkins
  • If it works, developers are still not able to login into the running MySQL container because of an unknown issue. Please fix these issue before moving to the next part.

Further improvement requests

  • Pipeline should fail if the MySQL port parameter is not a valid number within port range
  • Developers would also need a table called "departments" under the "DEVAPP" database with the following columns and with some demo data populated
    • DEPT - number 4 digit
    • DEPT_NAME - varchar 250
  • Please share any observation / recommendation you might have on this process

My observations (lcosta)

  • The groovy script can be optimized for improved efficiency by utilizing Jenkins plugins for tasks such as interacting with Docker. It's worth noting that there is a minimal overhead associated with starting Docker containers, however, this will be addressed in future releases of the pipeline.
  • To enhance clarity, it may be beneficial to re-arrange the steps in the script. Additionally, certain instances of the 'sh' command usage may be redundant and can be accomplished within the groovy script itself.
  • As a best practice in secure scripting, it is important to avoid exposing credentials in any script, even if it is executed locally. The risk of these sensitive details being inadvertently uploaded to an online repository is significant, and therefore, it is essential to maintain secure practices in script development.

Optional

  • Extend the pipeline with ability to switch database engine and implement the same scope using either: