Ansible collection for Bitbucket

Target

This collection was created to manipulate Bitbucket's repositories and deployments.

Warning: This collection uses a mix of internal and external APIs of Bitbucket, changes in internal APIs can broke the collection.

Usage

Install

ansible-galaxy collection  install juanenriqueescobar.bitbucket

Username and Password

This module was tested using "App passwords", to create one follow this steps here.

Note about secured vars

When the var was created as secured is impossible to compare the remote stored value with the local value, so the module can't determine if is needed to update or not, to fix this behavior the module create another non secured var with the sha256 of the secret.

To determine if var is changed, the module compare the var hash and the remote stored hash.

When the module is call with state: absent both vars will be delete.

Example:

Modules

Every module has his own documentation with more details.

Pipelines enabled

Enable or disable pipelines in the repo

- juanenriqueescobar.bitbucket.pipelines_enabled:
    username:    String
    password:    String
    repository:  String      
    state:       present|absent

Repository Var

Modify repository's vars

- juanenriqueescobar.bitbucket.repository_var:
    username:    String
    password:    String
    repository:  String      
    state:       present|absent
    var_name:    String
    var_value:   String
    var_secured: Bool

Deployment

Modify repository's deployments

- juanenriqueescobar.bitbucket.deployment:
    username:    String
    password:    String
    repository:  String      
    state:       present|absent
    deployment:  String
    type:        Test|Staging|Production

Deployment Pattern

Modify deployment's pattern

- juanenriqueescobar.bitbucket.deployment_pattern:
    username:    String
    password:    String
    repository:  String      
    state:       present|absent
    deployment:  String
    pattern:     String

Deployment Var

Modify deployment's vars

- juanenriqueescobar.bitbucket.deployment_var:
    username:    String
    password:    String
    repository:  String      
    state:       present|absent
    deployment:  String
    var_name:    String
    var_value:   String
    var_secured: Bool

Examples

- name: enable pipelines in repository
  juanenriqueescobar.bitbucket.pipelines_enabled:
    username:    myuser
    password:    password-generated-by-bitbucket
    repository:  myworkspace/myrepo
    state:       present

- name: create secured variable at repository level  
  juanenriqueescobar.bitbucket.repository_var:
    username:    myuser
    password:    password-generated-by-bitbucket
    repository:  myworkspace/myrepo
    state:       present
    var_name:    Application
    var_value:   us-east-app-1
    var_secured: false

- name: create deployment
  juanenriqueescobar.bitbucket.deployment:
    username:    myuser
    password:    password-generated-by-bitbucket
    repository:  myworkspace/myrepo
    state:       present
    deployment:  region-us-east-1
    type:        Production

- name: set the branch pattern for deployment
  juanenriqueescobar.bitbucket.deployment_pattern:
    username:    myuser
    password:    password-generated-by-bitbucket
    repository:  myworkspace/myrepo
    state:       present
    deployment:  region-us-east-1
    pattern:     deploy/us-east-1

- name: create variable at deployment level
  juanenriqueescobar.bitbucket.deployment_var:
    username:    myuser
    password:    password-generated-by-bitbucket
    repository:  myworkspace/myrepo
    state:       present
    deployment:  region-us-east-1
    var_name:    AWS_SECRET_ACCESS_KEY
    var_value:   "{{secrets.us_east_1.ACCESS_KEY}}"
    var_secured: true

Roles

Ensure pipeline

Create the repository vars and deployment with his pattern and vars.

Develop

TODO

Configure Test

TODO

Running Test

TODO

Coverage

TODO

TODO

• more doc
• how test roles?
• modules:
  • create repo
  • repo permisions
  • workspace vars