Does gickup support backing up private Bitbucket repositories?

[donaldm314]

Does gickup support backing up private Bitbucket repositories?

I have backed up my GitHub account using gickup version 0.10.31, including its private repos, so I tried with Bitbucket. Unfortunately, it only downloaded my public repos.

My configuration:

source:
  bitbucket:
    - username: donaldm314
      token: /path/to/bitbucket-token
      ssh: true
destination:
  local:
    - path: /full/path/to/git-mirrors
      structured: true

And the output from a debug run:

2024-08-08T13:31:02-06:00 INF Reading gickup-bitbucket.yaml file=gickup-bitbucket.yaml
2024-08-08T13:31:02-06:00 INF Configuration loaded destinations=1 pairs=1 sources=1
2024-08-08T13:31:02-06:00 INF Backup run starting
2024-08-08T13:31:02-06:00 INF grabbing repositories from donaldm314 stage=bitbucket url=https://api.bitbucket.org/2.0
2024-08-08T13:31:03-06:00 DBG https://bitbucket.org/donaldm314/docker-write-to-host.git stage=bitbucket url=https://api.bitbucket.org/2.0
2024-08-08T13:31:03-06:00 DBG https://bitbucket.org/donaldm314/bitbucket-pipeline-docker-cache.git stage=bitbucket url=https://api.bitbucket.org/2.0
...
2024-08-08T13:31:03-06:00 INF starting backup for https://bitbucket.org/donaldm314/docker-write-to-host.git stage=backup
2024-08-08T13:31:03-06:00 INF opening api.bitbucket.org/donaldm314/docker-write-to-host locally path=/full/path/to/git-mirrors stage=locally
2024-08-08T13:31:05-06:00 INF pulling api.bitbucket.org/donaldm314/docker-write-to-host path=/full/path/to/git-mirrors stage=locally
2024-08-08T13:31:07-06:00 INF already up-to-date path=/full/path/to/git-mirrors stage=locally
2024-08-08T13:31:07-06:00 INF starting backup for https://bitbucket.org/donaldm314/bitbucket-pipeline-docker-cache.git stage=backup
2024-08-08T13:31:07-06:00 INF opening api.bitbucket.org/donaldm314/bitbucket-pipeline-docker-cache locally path=/full/path/to/git-mirrors stage=locally
2024-08-08T13:31:08-06:00 INF pulling api.bitbucket.org/donaldm314/bitbucket-pipeline-docker-cache path=/full/path/to/git-mirrors stage=locally
2024-08-08T13:31:10-06:00 INF already up-to-date path=/full/path/to/git-mirrors stage=locally
...
2024-08-08T13:31:31-06:00 INF Backup run complete duration=28.487602429s

Bitbucket says my token has never been accessed, which seems suspicious.

[cooperspencer]

Can you try to change username to user? Username is actually just for authentication purposes against the hoster.

[cooperspencer]

I just tried to backup my test repos on bitbucket, you are indeed correct. I'll have to investigate what the problem might be.

Just FYI, it will take me some time as I won't have access to my PC for about a week.

[cooperspencer]

I had another look at it and I have a workaround for the meantime.

source:
  bitbucket:
    - username: donaldm314
      user: donaldm314
      password: <your-token> # not the file, but the actual token
      ssh: true

This should work. I will fix that behavior after I return back home.

[donaldm314]

Thanks for looking into this! That workaround did not change the result.

[cooperspencer]

I think I fixed it. At least for me it works as intended.
Can you download the build from https://github.com/cooperspencer/gickup/actions/runs/10473449628 and try if it works for you?

[cooperspencer]

please download the build from here: https://github.com/cooperspencer/gickup/actions/runs/10474396886
This includes the token_file option too.

[donaldm314]

That build gives me a 401 error:

./gickup --version && ./gickup gickup-bitbucket.yaml 
0.0.0-SNAPSHOT-ca596af
2024-08-24T14:32:11-06:00 INF Reading gickup-bitbucket.yaml file=gickup-bitbucket.yaml
2024-08-24T14:32:11-06:00 INF Configuration loaded destinations=1 pairs=1 sources=1
2024-08-24T14:32:11-06:00 INF Backup run starting
2024-08-24T14:32:11-06:00 INF grabbing repositories from donaldm314 stage=bitbucket url=https://api.bitbucket.org/2.0
2024-08-24T14:32:11-06:00 ERR 401 Unauthorized stage=bitbucket url=https://api.bitbucket.org/2.0
2024-08-24T14:32:11-06:00 INF Backup run complete duration=329.559972ms

[cooperspencer]

that is weird.
Here is a step by step tutorial on how I created a backup for bitbucket:

1. I created an app password with the needed permission:
   
   
2. Then I create the configuration file like this:

source:
  bitbucket:
    - user: buddyspencer
      token_file: token.txt
destination:
  local:
    - path: ~/test_backup
      structured: true

token.txt contains my app password from earlier.

This configuration works perfectly fine for me.

[donaldm314]

Okay, it's working now, and with version 0.10.31!

I followed your instructions above, creating a new personal app password. The other change I made: token: became token_file: in my configuration file. These two changes were sufficient to allow gickup to read all my Bitbucket repositories -- public and private.

Thanks so much for your help!

[cooperspencer]

You are very welcome. I am glad everything worked out