turbot/steampipe-plugin-bitbucket

Use SQL to instantly query Bitbucket. Open source CLI. No DB required.

Bitbucket Plugin for Steampipe

Use SQL to query repositories, projects, merge requests and more from Bitbucket.

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install bitbucket

Run a query:

select name, uuid, is_private, full_name from bitbucket_my_repository;

Engines

This plugin is available for the following engines:

Engine	Description
Steampipe	The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
Postgres FDW	Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
SQLite Extension	Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
Export	Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
Turbot Pipes	Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/turbot/steampipe-plugin-bitbucket.git
cd steampipe-plugin-bitbucket

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/bitbucket.spc

Try it!

steampipe query
> .inspect bitbucket

Further reading:

• Writing plugins
• Writing your first table

Open Source & Contributing

This repository is published under the Apache 2.0 (source code) and CC BY-NC-ND (docs) licenses. Please see our code of conduct. We look forward to collaborating with you!

Steampipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #steampipe on Slack →

Want to help but don't know where to start? Pick up one of the help wanted issues:

• Steampipe
• Bitbucket Plugin

steampipe-plugin-bitbucket's Issues

Update steampipe-plugin-sdk to v1.6.1

Add table bitbucket_commit

References
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit

Request to support Bitbucket access tokens for authentication

This feature request is to support Bitbucket access tokens to authenticate the connection to Bitbucket cloud. Here is the reference - https://bitbucket.org/blog/access-your-bitbucket-cloud-repositories-more-securely-with-resource-scoped-access-tokens

Add list call ListDefaultReviewers in the table bitbucket_my_repository

List call ListDefaultReviewers should be added to the table bitbucket_my_repository to display the name of the default reviewers in that repository.
For the repository test-org-repo-public the default reviewers are shown:

Extend bitbucket_workspace_member to capture MFA info for the user

Is your feature request related to a problem? Please describe.
Finding the existing members enabled with MFA will help.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Update steampipe-plugin-sdk to v1.3.1

Review source code for v0.0.1 release

Add table bitbucket_issue

References
Add any related links that will help us understand the resource, including vendor documentation, related GitHub issues, and Go SDK documentation.

Add table bitbucket_branch

References
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/refs/branches

Include a boolean field for "Branch Restrictions Inheritance" or similar on the bitbucket_branch_restriction or both bitbucket_my_repository and bitbucket_repository

Is your feature request related to a problem? Please describe.
I have been working with the bitbucket plugin for a while now and one of my use cases refers to the "bitbucket_branch_restriction" table, so that I can find out if there are repositories with insecure permissions. My issue right now is that there are repositories that inherit branch restrictions from the project, as you can see here:

When I use the query to show branch restrictions for this particular repository, the result is as if it was not set, as you can see below, which is not true (inherited):

Describe the solution you'd like
I believe that using the API endpoint below to include one extra column to the bitbucket_my_repository table could solve my problem temporarily, as there seems like a project settings api for querying branch restrictions at the project level does not exist yet (I requested it though):
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-override-settings-get
One thing to note is that this endpoint won't work with the current personal access token, as you can see below:

For this api endpoint to work, we will need the Workspace Access Token, that can be created at:
https://bitbucket.org//workspace/settings/access-tokens
When it works correctly, the result should be like this:

Describe alternatives you've considered
I have no other idea at the moment other than using the GUI, unfortunately.

Additional context
No other context I can offer here.

Add table bitbucket_repository_wiki

References
Gather wiki setting details for Bitbucket.

Add table docs for release

Add table bitbucket_branch_restriction

References
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/branch-restrictions
Assume that we need to check - Brach permission should prohibit "Allow deleting this branch" option to only users in Administrator group (New)

Add table bitbucket_ pipelines_deployments

References
Add any related links that will help us understand the resource, including vendor documentation, related GitHub issues, and Go SDK documentation.

Unable to get information about more than 10 branches in Bitbucket Plugin

Describe the bug
Unable to get information about more than 10 branches.

Steampipe version (steampipe -v)
v0.15.3

Plugin version (steampipe plugin list)
v0.2.1

To reproduce
Steps to reproduce the behavior .

Need to have more than 10 branches in a repository

select
  count(*)
from
  bitbucket_branch
where
  repository_full_name='workspace-name/repo-name'

Expected behavior
Get the count of all branches present in the repo

Additional context
Plugin: Bitbucket
Currently giving maximum branch count as 10, even if the actual count is greater.

Update credentials scope for app password in the doc.

Describe the bug
https://hub.steampipe.io/plugins/turbot/bitbucket > Credential scope requires change as per the web-console
same update required in ~/.steampipe/config/bitbucket.spc

Plugin version (steampipe -v)
0.0.1

Plugin version (steampipe plugin list)
Example: v0.5.0

To reproduce

**Expected behavior** A clear and concise description of what you expected to happen.

Additional context
Add any other context about the problem here.

Extend bitbucket_workspace to add plan information.

References
To get information about the plan and relation consumption metrics if any

Add bitbucket_workspace_member table with associated group info.

Is your feature request related to a problem? Please describe.
Current table does not provide info for associated grp info. Good to have this col is captured.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Add table bitbucket_group

References
https://support.atlassian.com/bitbucket-cloud/docs/groups-endpoint/
There is no 2.0 BitBucket API currently available for Groups. Deprecated 1.0 BitBucket API for the group is on temporary support.

Add table `bitbucket_my_repository` and `bitbucket_repository`

v0.0.1

Add table bitbucket_tag

References
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/refs/tags

invalid scopes in bitbucket.spc file

Describe the bug

the .spc file contains scopes for "read:user" and "user:read" but they don't exist

Steampipe version (steampipe -v)**
v0.16.4

bitbucket plugin v0.3.0

To reproduce
install the plugin and look at the .spc file

Expected behavior
only valid scopes are listed

Add `table bitbucket_project`, `bitbucket_workspace` and `bitbucket_workspace_member`

References
Add any related links that will help us understand the resource, including vendor documentation, related GitHub issues, and Go SDK documentation.

Add table bitbucket_repository_permission

References
https://api.bitbucket.org/2.0/workspaces/LalitFort/permissions/repositories/steampipe-plugin-bitbucket

https://developer.atlassian.com/bitbucket/api/2/reference/resource/workspaces/%7Bworkspace%7D/permissions/repositories/%7Brepo_slug%7D

Please provide support for environment variables for username and app password or access token

It would be nice if this plugin can support using environment variables for Bitbucket username and app password, or even better if it can support access tokens which are more generic in nature and don't require a specific user.

Support on-prem Bitbucket Server

Is your feature request related to a problem? Please describe.
This plugin does not work with bitbucket-server (on-premise) installation, as it's rest-API is different than hosted bitbucket.

Describe the solution you'd like
Plugin updated to work with the on-prem API

Describe alternatives you've considered
None, I need this to be able to use steampipe.

Add column role in table bitbucket_workspace_member

Table bitbucket_workspace_member should have a column role that would be reflecting the groups roles that a particular member has in a workspace.
Here it is showing the roles that Madhushree Ray has in the turbotdev workspace

Add table bitbucket_snippet

References
https://developer.atlassian.com/bitbucket/api/2/reference/resource/snippets

Add repository website detail in bitbucket_repository table

References
Adding advance info for the repo will be helpful.
https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D#get

Add connection config, goreleaser.yml and github workflows for plugin

Add table bitbucket_audit_log

References
Add any related links that will help us understand the resource, including vendor documentation, related GitHub issues, and Go SDK documentation.

Add table bitbucket_ pipelines_repository_variables

References
Add any related links that will help us understand the resource, including vendor documentation, related GitHub issues, and Go SDK documentation.

Add table bitbucket_workspace

References
Add any related links that will help us understand the resource, including vendor documentation, related GitHub issues, and Go SDK documentation.

Add table bitbucket_repository_pull_request

References
Additional data for the PR table to include default reviewer list, excluded files, description etc..

v0.0.2

Add table bitbucket_pull_request

References
Add any related links that will help us understand the resource, including vendor documentation, related GitHub issues, and Go SDK documentation.