This is a monorepo containing scripts to generate data specifically for Atlassian server and cloud platforms.
Ideally, these scripts can be used in development for load testing purposes. References for load profiles:
To begin using this repo, head straight to Section: Get started.
- 💪 To increase productivity by having scripts that can run everywhere with minimal setup
- 🙌 To encourage collaboration by centralizing scripts related to seeding Atlassian data written in various programming languages
The initial idea is to organize the scripts by language.
Generally, the folder can be structured as follows:
.
└── ruby
├── Gemfile
├── Gemfile.lock
├── README.md
└── scripts
└── jira-server
├── script1.rb
├── script2.rb
├── ...
└── jira-cloud
├── script1.rb
├── script2.rb
└── ...
The steps here assume ruby
as the language chosen for running scripts.
However, the steps are the same when using other language.
- Docker
- Running instance(s)
- Credentials for Atlassian API
- For server, typically this is default to
admin
for username and password - For cloud, refer here on how to generate API token.
- For server, typically this is default to
- (For server) A tool for exposing port from local machine like
ngrok
- Copy the configs template
- For server:
$ cp config-server-sample.yml config-server.yml
- For cloud:
$ cp config-cloud-sample.yml config-cloud.yml
- For server:
- Update the values in the respective
.yml
files
- From the root level, run a specific service:
$ docker-compose up --build -d ruby_scripts
- The
docker-compose.yml
can be designed to have multiple services that run containers with the ability to execute scripts written in different language.
- The
- Verify that the container is running:
$ docker ps
- To begin using the scripts, SSH into the container:
$ docker exec -it ruby_scripts /bin/bash
- (Optional) To terminate the container:
$ docker-compose down
👉 The steps here assume that the language of choice has been installed.
- Move the generated credentials into the folder containing the scripts.
- For server:
$ cp config-server.yml ruby/
- For cloud:
$ cp config-cloud.yml ruby/
- For server:
$ cd ruby
$ bundle install
Refer CONTRIBUTING.md