mirror of
https://github.com/josegonzalez/python-github-backup.git
synced 2025-12-22 23:51:11 +01:00
Compare commits
67 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
81a72ac8af | ||
|
|
3edbfc777c | ||
|
|
3c43e0f481 | ||
|
|
875f09eeaf | ||
|
|
db36c3c137 | ||
|
|
c70cc43f57 | ||
|
|
27d3fcdafa | ||
|
|
46140b0ff1 | ||
|
|
02dd902b67 | ||
|
|
241949137d | ||
|
|
1155da849d | ||
|
|
59a70ff11a | ||
|
|
ba852b5830 | ||
|
|
934ee4b14b | ||
|
|
37a0c5c123 | ||
|
|
f6e2f40b09 | ||
|
|
ef990483e2 | ||
|
|
3a513b6646 | ||
|
|
2bb83d6d8b | ||
|
|
8fcc142621 | ||
|
|
7615ce6102 | ||
|
|
3f1ef821c3 | ||
|
|
3684756eaa | ||
|
|
e745b55755 | ||
|
|
75e6f56773 | ||
|
|
b991c363a0 | ||
|
|
6d74af9126 | ||
|
|
381d67af96 | ||
|
|
2fbe8d272c | ||
|
|
eb5779ac23 | ||
|
|
5b52931ebf | ||
|
|
1d6d474408 | ||
|
|
b80049e96e | ||
|
|
58ad1c2378 | ||
|
|
6e2a7e521c | ||
|
|
aba048a3e9 | ||
|
|
9f7c08166f | ||
|
|
fdfaaec1ba | ||
|
|
8f9cf7ff89 | ||
|
|
899ab5fdc2 | ||
|
|
2a9d86a6bf | ||
|
|
4fd3ea9e3c | ||
|
|
041dc013f9 | ||
|
|
12802103c4 | ||
|
|
bf28b46954 | ||
|
|
ff2681e196 | ||
|
|
745b05a63f | ||
|
|
83ff0ae1dd | ||
|
|
6ad1959d43 | ||
|
|
5739ac0745 | ||
|
|
8b7512c8d8 | ||
|
|
995b7ede6c | ||
|
|
7840528fe2 | ||
|
|
6fb0d86977 | ||
|
|
9f6b401171 | ||
|
|
bf638f7aea | ||
|
|
c3855a94f1 | ||
|
|
c3f4bfde0d | ||
|
|
d3edef0622 | ||
|
|
9ef496efad | ||
|
|
42bfe6f79d | ||
|
|
5af522a348 | ||
|
|
6dfba7a783 | ||
|
|
7551829677 | ||
|
|
72d35a9b94 | ||
|
|
3eae9d78ed | ||
|
|
90ba839c7d |
2
.github/workflows/automatic-release.yml
vendored
2
.github/workflows/automatic-release.yml
vendored
@@ -18,7 +18,7 @@ jobs:
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
ssh-key: ${{ secrets.DEPLOY_PRIVATE_KEY }}
|
||||
|
||||
2
.github/workflows/docker.yml
vendored
2
.github/workflows/docker.yml
vendored
@@ -38,7 +38,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
|
||||
2
.github/workflows/lint.yml
vendored
2
.github/workflows/lint.yml
vendored
@@ -21,7 +21,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Setup Python
|
||||
|
||||
2
.github/workflows/test.yml
vendored
2
.github/workflows/test.yml
vendored
@@ -21,7 +21,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Setup Python
|
||||
|
||||
378
CHANGES.rst
378
CHANGES.rst
@@ -1,9 +1,385 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
0.51.1 (2025-11-16)
|
||||
0.59.0 (2025-12-21)
|
||||
-------------------
|
||||
------------------------
|
||||
- Add --starred-skip-size-over flag to limit starred repo size (#108)
|
||||
[Rodos]
|
||||
|
||||
Allow users to skip starred repositories exceeding a size threshold
|
||||
when using --all-starred. Size is specified in MB and checked against
|
||||
the GitHub API's repository size field.
|
||||
|
||||
- Only affects starred repos; user's own repos always included
|
||||
- Logs each skipped repo with name and size
|
||||
|
||||
Closes #108
|
||||
- Chore: remove deprecated -u/-p password authentication options.
|
||||
[Rodos]
|
||||
|
||||
|
||||
0.58.0 (2025-12-16)
|
||||
-------------------
|
||||
- Fix retry logic for HTTP 5xx errors and network failures. [Rodos]
|
||||
|
||||
Refactors error handling to retry all 5xx errors (not just 502), network errors (URLError, socket.error, IncompleteRead), and JSON parse errors with exponential backoff and jitter. Respects retry-after and rate limit headers per GitHub API requirements. Consolidates retry logic into make_request_with_retry() wrapper and adds clear logging for retry attempts and failures. Removes dead code from 2016 (errors list, _request_http_error, _request_url_error) that was intentionally disabled in commit 1e5a9048 to fix #29.
|
||||
|
||||
Fixes #140, #110, #138
|
||||
- Chore: remove transitive deps from release-requirements.txt. [Rodos]
|
||||
- Chore(deps): bump urllib3 in the python-packages group.
|
||||
[dependabot[bot]]
|
||||
|
||||
Bumps the python-packages group with 1 update: [urllib3](https://github.com/urllib3/urllib3).
|
||||
|
||||
|
||||
Updates `urllib3` from 2.6.1 to 2.6.2
|
||||
- [Release notes](https://github.com/urllib3/urllib3/releases)
|
||||
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
|
||||
- [Commits](https://github.com/urllib3/urllib3/compare/2.6.1...2.6.2)
|
||||
|
||||
---
|
||||
updated-dependencies:
|
||||
- dependency-name: urllib3
|
||||
dependency-version: 2.6.2
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-patch
|
||||
dependency-group: python-packages
|
||||
...
|
||||
|
||||
|
||||
0.57.0 (2025-12-12)
|
||||
-------------------
|
||||
- Add GitHub Apps documentation and remove outdated header. [Rodos]
|
||||
|
||||
- Add GitHub Apps authentication section with setup steps
|
||||
and CI/CD workflow example using actions/create-github-app-token
|
||||
- Remove outdated machine-man-preview header (graduated 2020)
|
||||
|
||||
Closes #189
|
||||
- Docs: add stdin token example to README. [Rodos]
|
||||
|
||||
Add example showing how to pipe a token from stdin using
|
||||
file:///dev/stdin to avoid storing tokens in environment
|
||||
variables or command history.
|
||||
|
||||
Closes #187
|
||||
- Add --skip-assets-on flag to skip release asset downloads (#135)
|
||||
[Rodos]
|
||||
|
||||
Allow users to skip downloading release assets for specific repositories
|
||||
while still backing up release metadata. Useful for starred repos with
|
||||
large assets (e.g. syncthing with 27GB+).
|
||||
|
||||
Usage: --skip-assets-on repo1 repo2 owner/repo3
|
||||
|
||||
Features:
|
||||
- Space-separated repos (consistent with --exclude)
|
||||
- Case-insensitive matching
|
||||
- Supports both repo name and owner/repo format
|
||||
|
||||
|
||||
0.56.0 (2025-12-11)
|
||||
-------------------
|
||||
|
||||
Fix
|
||||
~~~
|
||||
- Replace deprecated git lfs clone with git clone + git lfs fetch --all.
|
||||
[Rodos]
|
||||
|
||||
git lfs clone is deprecated - modern git clone handles LFS automatically.
|
||||
Using git lfs fetch --all ensures all LFS objects across all refs are
|
||||
backed up, matching the existing bare clone behavior and providing
|
||||
complete LFS backups.
|
||||
|
||||
Closes #379
|
||||
- Add Windows support with entry_points and os.replace. [Rodos]
|
||||
|
||||
- Replace os.rename() with os.replace() for atomic file operations
|
||||
on Windows (os.rename fails if destination exists on Windows)
|
||||
- Add entry_points console_scripts for proper .exe generation on Windows
|
||||
- Create github_backup/cli.py with main() entry point
|
||||
- Add github_backup/__main__.py for python -m github_backup support
|
||||
- Keep bin/github-backup as thin wrapper for backwards compatibility
|
||||
|
||||
Closes #112
|
||||
|
||||
Other
|
||||
~~~~~
|
||||
- Docs: add "Restoring from Backup" section to README. [Rodos]
|
||||
|
||||
Clarifies that this tool is backup-only with no inbuilt restore.
|
||||
Documents that git repos can be pushed back, but issues/PRs have
|
||||
GitHub API limitations affecting all backup tools.
|
||||
|
||||
Closes #246
|
||||
- Chore(deps): bump urllib3 in the python-packages group.
|
||||
[dependabot[bot]]
|
||||
|
||||
Bumps the python-packages group with 1 update: [urllib3](https://github.com/urllib3/urllib3).
|
||||
|
||||
|
||||
Updates `urllib3` from 2.6.0 to 2.6.1
|
||||
- [Release notes](https://github.com/urllib3/urllib3/releases)
|
||||
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
|
||||
- [Commits](https://github.com/urllib3/urllib3/compare/2.6.0...2.6.1)
|
||||
|
||||
---
|
||||
updated-dependencies:
|
||||
- dependency-name: urllib3
|
||||
dependency-version: 2.6.1
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-patch
|
||||
dependency-group: python-packages
|
||||
...
|
||||
- Chore(deps): bump the python-packages group with 3 updates.
|
||||
[dependabot[bot]]
|
||||
|
||||
Bumps the python-packages group with 3 updates: [black](https://github.com/psf/black), [pytest](https://github.com/pytest-dev/pytest) and [platformdirs](https://github.com/tox-dev/platformdirs).
|
||||
|
||||
|
||||
Updates `black` from 25.11.0 to 25.12.0
|
||||
- [Release notes](https://github.com/psf/black/releases)
|
||||
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
|
||||
- [Commits](https://github.com/psf/black/compare/25.11.0...25.12.0)
|
||||
|
||||
Updates `pytest` from 9.0.1 to 9.0.2
|
||||
- [Release notes](https://github.com/pytest-dev/pytest/releases)
|
||||
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
|
||||
- [Commits](https://github.com/pytest-dev/pytest/compare/9.0.1...9.0.2)
|
||||
|
||||
Updates `platformdirs` from 4.5.0 to 4.5.1
|
||||
- [Release notes](https://github.com/tox-dev/platformdirs/releases)
|
||||
- [Changelog](https://github.com/tox-dev/platformdirs/blob/main/CHANGES.rst)
|
||||
- [Commits](https://github.com/tox-dev/platformdirs/compare/4.5.0...4.5.1)
|
||||
|
||||
---
|
||||
updated-dependencies:
|
||||
- dependency-name: black
|
||||
dependency-version: 25.12.0
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-minor
|
||||
dependency-group: python-packages
|
||||
- dependency-name: pytest
|
||||
dependency-version: 9.0.2
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-patch
|
||||
dependency-group: python-packages
|
||||
- dependency-name: platformdirs
|
||||
dependency-version: 4.5.1
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-patch
|
||||
dependency-group: python-packages
|
||||
...
|
||||
|
||||
|
||||
0.55.0 (2025-12-07)
|
||||
-------------------
|
||||
|
||||
Fix
|
||||
~~~
|
||||
- Improve error messages for inaccessible repos and empty wikis. [Rodos]
|
||||
- --all-starred now clones repos without --repositories. [Rodos]
|
||||
- Warn when --private used without authentication. [Rodos]
|
||||
- Warn and skip when --starred-gists used for different user. [Rodos]
|
||||
|
||||
GitHub's API only allows retrieving starred gists for the authenticated
|
||||
user. Previously, using --starred-gists when backing up a different user
|
||||
would silently return no relevant data.
|
||||
|
||||
Now warns and skips the retrieval entirely when the target user differs
|
||||
from the authenticated user. Uses case-insensitive comparison to match
|
||||
GitHub's username handling.
|
||||
|
||||
Fixes #93
|
||||
|
||||
Other
|
||||
~~~~~
|
||||
- Test: add missing test coverage for case sensitivity fix. [Rodos]
|
||||
- Docs: fix RST formatting in Known blocking errors section. [Rodos]
|
||||
- Chore(deps): bump urllib3 from 2.5.0 to 2.6.0. [dependabot[bot]]
|
||||
|
||||
Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.5.0 to 2.6.0.
|
||||
- [Release notes](https://github.com/urllib3/urllib3/releases)
|
||||
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
|
||||
- [Commits](https://github.com/urllib3/urllib3/compare/2.5.0...2.6.0)
|
||||
|
||||
---
|
||||
updated-dependencies:
|
||||
- dependency-name: urllib3
|
||||
dependency-version: 2.6.0
|
||||
dependency-type: direct:production
|
||||
...
|
||||
|
||||
|
||||
0.54.0 (2025-12-03)
|
||||
-------------------
|
||||
|
||||
Fix
|
||||
~~~
|
||||
- Send INFO/DEBUG to stdout, WARNING/ERROR to stderr. [Rodos]
|
||||
|
||||
Fixes #182
|
||||
|
||||
Other
|
||||
~~~~~
|
||||
- Docs: update README testing section and add fetch vs pull explanation.
|
||||
[Rodos]
|
||||
|
||||
|
||||
0.53.0 (2025-11-30)
|
||||
-------------------
|
||||
|
||||
Fix
|
||||
~~~
|
||||
- Case-sensitive username filtering causing silent backup failures.
|
||||
[Rodos]
|
||||
|
||||
GitHub's API accepts usernames in any case but returns canonical case.
|
||||
The case-sensitive comparison in filter_repositories() filtered out all
|
||||
repositories when user-provided case didn't match GitHub's canonical case.
|
||||
|
||||
Changed to case-insensitive comparison.
|
||||
|
||||
Fixes #198
|
||||
|
||||
Other
|
||||
~~~~~
|
||||
- Avoid rewriting unchanged JSON files for labels, milestones, releases,
|
||||
hooks, followers, and following. [Rodos]
|
||||
|
||||
This change reduces unnecessary writes when backing up metadata that changes
|
||||
infrequently. The implementation compares existing file content before writing
|
||||
and skips the write if the content is identical, preserving file timestamps.
|
||||
|
||||
Key changes:
|
||||
- Added json_dump_if_changed() helper that compares content before writing
|
||||
- Uses atomic writes (temp file + rename) for all metadata files
|
||||
- NOT applied to issues/pulls (they use incremental_by_files logic)
|
||||
- Made log messages consistent and past tense ("Saved" instead of "Saving")
|
||||
- Added informative logging showing skip counts
|
||||
|
||||
Fixes #133
|
||||
|
||||
|
||||
0.52.0 (2025-11-28)
|
||||
-------------------
|
||||
- Skip DMCA'd repos which return a 451 response. [Rodos]
|
||||
|
||||
Log a warning and the link to the DMCA notice. Continue backing up
|
||||
other repositories instead of crashing.
|
||||
|
||||
Closes #163
|
||||
- Chore(deps): bump restructuredtext-lint in the python-packages group.
|
||||
[dependabot[bot]]
|
||||
|
||||
Bumps the python-packages group with 1 update: [restructuredtext-lint](https://github.com/twolfson/restructuredtext-lint).
|
||||
|
||||
|
||||
Updates `restructuredtext-lint` from 1.4.0 to 2.0.2
|
||||
- [Changelog](https://github.com/twolfson/restructuredtext-lint/blob/master/CHANGELOG.rst)
|
||||
- [Commits](https://github.com/twolfson/restructuredtext-lint/compare/1.4.0...2.0.2)
|
||||
|
||||
---
|
||||
updated-dependencies:
|
||||
- dependency-name: restructuredtext-lint
|
||||
dependency-version: 2.0.2
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-major
|
||||
dependency-group: python-packages
|
||||
...
|
||||
- Chore(deps): bump actions/checkout from 5 to 6. [dependabot[bot]]
|
||||
|
||||
Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
|
||||
- [Release notes](https://github.com/actions/checkout/releases)
|
||||
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
|
||||
- [Commits](https://github.com/actions/checkout/compare/v5...v6)
|
||||
|
||||
---
|
||||
updated-dependencies:
|
||||
- dependency-name: actions/checkout
|
||||
dependency-version: '6'
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-major
|
||||
...
|
||||
- Chore(deps): bump the python-packages group with 3 updates.
|
||||
[dependabot[bot]]
|
||||
|
||||
Bumps the python-packages group with 3 updates: [click](https://github.com/pallets/click), [pytest](https://github.com/pytest-dev/pytest) and [keyring](https://github.com/jaraco/keyring).
|
||||
|
||||
|
||||
Updates `click` from 8.3.0 to 8.3.1
|
||||
- [Release notes](https://github.com/pallets/click/releases)
|
||||
- [Changelog](https://github.com/pallets/click/blob/main/CHANGES.rst)
|
||||
- [Commits](https://github.com/pallets/click/compare/8.3.0...8.3.1)
|
||||
|
||||
Updates `pytest` from 8.3.3 to 9.0.1
|
||||
- [Release notes](https://github.com/pytest-dev/pytest/releases)
|
||||
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
|
||||
- [Commits](https://github.com/pytest-dev/pytest/compare/8.3.3...9.0.1)
|
||||
|
||||
Updates `keyring` from 25.6.0 to 25.7.0
|
||||
- [Release notes](https://github.com/jaraco/keyring/releases)
|
||||
- [Changelog](https://github.com/jaraco/keyring/blob/main/NEWS.rst)
|
||||
- [Commits](https://github.com/jaraco/keyring/compare/v25.6.0...v25.7.0)
|
||||
|
||||
---
|
||||
updated-dependencies:
|
||||
- dependency-name: click
|
||||
dependency-version: 8.3.1
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-patch
|
||||
dependency-group: python-packages
|
||||
- dependency-name: pytest
|
||||
dependency-version: 9.0.1
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-major
|
||||
dependency-group: python-packages
|
||||
- dependency-name: keyring
|
||||
dependency-version: 25.7.0
|
||||
dependency-type: direct:production
|
||||
update-type: version-update:semver-minor
|
||||
dependency-group: python-packages
|
||||
...
|
||||
|
||||
|
||||
0.51.3 (2025-11-18)
|
||||
-------------------
|
||||
- Test: Add pagination tests for cursor and page-based Link headers.
|
||||
[Rodos]
|
||||
- Use cursor based pagination. [Helio Machado]
|
||||
|
||||
|
||||
0.51.2 (2025-11-16)
|
||||
-------------------
|
||||
|
||||
Fix
|
||||
~~~
|
||||
- Improve CA certificate detection with fallback chain. [Rodos]
|
||||
|
||||
The previous implementation incorrectly assumed empty get_ca_certs()
|
||||
meant broken SSL, causing false failures in GitHub Codespaces and other
|
||||
directory-based cert systems where certificates exist but aren't pre-loaded.
|
||||
It would then attempt to import certifi as a workaround, but certifi wasn't
|
||||
listed in requirements.txt, causing the fallback to fail with ImportError
|
||||
even though the system certificates would have worked fine.
|
||||
|
||||
This commit replaces the naive check with a layered fallback approach that
|
||||
checks multiple certificate sources. First it checks for pre-loaded system
|
||||
certs (file-based systems). Then it verifies system cert paths exist
|
||||
(directory-based systems like Ubuntu/Debian/Codespaces). Finally it attempts
|
||||
to use certifi as an optional fallback only if needed.
|
||||
|
||||
This approach eliminates hard dependencies (certifi is now optional), works
|
||||
in GitHub Codespaces without any setup, and fails gracefully with clear hints
|
||||
for resolution when SSL is actually broken rather than failing with
|
||||
ModuleNotFoundError.
|
||||
|
||||
Fixes #444
|
||||
|
||||
|
||||
0.51.1 (2025-11-16)
|
||||
-------------------
|
||||
|
||||
Fix
|
||||
~~~
|
||||
|
||||
194
README.rst
194
README.rst
@@ -36,23 +36,26 @@ Show the CLI help output::
|
||||
|
||||
CLI Help output::
|
||||
|
||||
github-backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN_CLASSIC]
|
||||
[-f TOKEN_FINE] [--as-app] [-o OUTPUT_DIRECTORY]
|
||||
[-l LOG_LEVEL] [-i] [--starred] [--all-starred]
|
||||
[--watched] [--followers] [--following] [--all] [--issues]
|
||||
[--issue-comments] [--issue-events] [--pulls]
|
||||
github-backup [-h] [-t TOKEN_CLASSIC] [-f TOKEN_FINE] [-q] [--as-app]
|
||||
[-o OUTPUT_DIRECTORY] [-l LOG_LEVEL] [-i]
|
||||
[--incremental-by-files]
|
||||
[--starred] [--all-starred] [--starred-skip-size-over MB]
|
||||
[--watched] [--followers] [--following] [--all]
|
||||
[--issues] [--issue-comments] [--issue-events] [--pulls]
|
||||
[--pull-comments] [--pull-commits] [--pull-details]
|
||||
[--labels] [--hooks] [--milestones] [--repositories]
|
||||
[--bare] [--lfs] [--wikis] [--gists] [--starred-gists]
|
||||
[--skip-archived] [--skip-existing] [-L [LANGUAGES ...]]
|
||||
[-N NAME_REGEX] [-H GITHUB_HOST] [-O] [-R REPOSITORY]
|
||||
[-P] [-F] [--prefer-ssh] [-v]
|
||||
[--bare] [--no-prune] [--lfs] [--wikis] [--gists]
|
||||
[--starred-gists] [--skip-archived] [--skip-existing]
|
||||
[-L [LANGUAGES ...]] [-N NAME_REGEX] [-H GITHUB_HOST]
|
||||
[-O] [-R REPOSITORY] [-P] [-F] [--prefer-ssh] [-v]
|
||||
[--keychain-name OSX_KEYCHAIN_ITEM_NAME]
|
||||
[--keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT]
|
||||
[--releases] [--latest-releases NUMBER_OF_LATEST_RELEASES]
|
||||
[--skip-prerelease] [--assets] [--attachments]
|
||||
[--exclude [REPOSITORY [REPOSITORY ...]]
|
||||
[--throttle-limit THROTTLE_LIMIT] [--throttle-pause THROTTLE_PAUSE]
|
||||
[--skip-prerelease] [--assets]
|
||||
[--skip-assets-on [SKIP_ASSETS_ON ...]] [--attachments]
|
||||
[--throttle-limit THROTTLE_LIMIT]
|
||||
[--throttle-pause THROTTLE_PAUSE]
|
||||
[--exclude [EXCLUDE ...]]
|
||||
USER
|
||||
|
||||
Backup a github account
|
||||
@@ -60,29 +63,29 @@ CLI Help output::
|
||||
positional arguments:
|
||||
USER github username
|
||||
|
||||
optional arguments:
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-u USERNAME, --username USERNAME
|
||||
username for basic auth
|
||||
-p PASSWORD, --password PASSWORD
|
||||
password for basic auth. If a username is given but
|
||||
not a password, the password will be prompted for.
|
||||
-f TOKEN_FINE, --token-fine TOKEN_FINE
|
||||
fine-grained personal access token or path to token
|
||||
(file://...)
|
||||
-t TOKEN_CLASSIC, --token TOKEN_CLASSIC
|
||||
-t, --token TOKEN_CLASSIC
|
||||
personal access, OAuth, or JSON Web token, or path to
|
||||
token (file://...)
|
||||
-f, --token-fine TOKEN_FINE
|
||||
fine-grained personal access token (github_pat_....),
|
||||
or path to token (file://...)
|
||||
-q, --quiet supress log messages less severe than warning, e.g.
|
||||
info
|
||||
--as-app authenticate as github app instead of as a user.
|
||||
-o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
|
||||
-o, --output-directory OUTPUT_DIRECTORY
|
||||
directory at which to backup the repositories
|
||||
-l LOG_LEVEL, --log-level LOG_LEVEL
|
||||
-l, --log-level LOG_LEVEL
|
||||
log level to use (default: info, possible levels:
|
||||
debug, info, warning, error, critical)
|
||||
-i, --incremental incremental backup
|
||||
--incremental-by-files incremental backup using modified time of files
|
||||
--incremental-by-files
|
||||
incremental backup based on modification date of files
|
||||
--starred include JSON output of starred repositories in backup
|
||||
--all-starred include starred repositories in backup [*]
|
||||
--starred-skip-size-over MB
|
||||
skip starred repositories larger than this size in MB
|
||||
--watched include JSON output of watched repositories in backup
|
||||
--followers include JSON output of followers in backup
|
||||
--following include JSON output of following users in backup
|
||||
@@ -100,20 +103,22 @@ CLI Help output::
|
||||
--milestones include milestones in backup
|
||||
--repositories include repository clone in backup
|
||||
--bare clone bare repositories
|
||||
--no-prune disable prune option for git fetch
|
||||
--lfs clone LFS repositories (requires Git LFS to be
|
||||
installed, https://git-lfs.github.com) [*]
|
||||
--wikis include wiki clone in backup
|
||||
--gists include gists in backup [*]
|
||||
--starred-gists include starred gists in backup [*]
|
||||
--skip-archived skip project if it is archived
|
||||
--skip-existing skip project if a backup directory exists
|
||||
-L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]]
|
||||
-L, --languages [LANGUAGES ...]
|
||||
only allow these languages
|
||||
-N NAME_REGEX, --name-regex NAME_REGEX
|
||||
-N, --name-regex NAME_REGEX
|
||||
python regex to match names against
|
||||
-H GITHUB_HOST, --github-host GITHUB_HOST
|
||||
-H, --github-host GITHUB_HOST
|
||||
GitHub Enterprise hostname
|
||||
-O, --organization whether or not this is an organization user
|
||||
-R REPOSITORY, --repository REPOSITORY
|
||||
-R, --repository REPOSITORY
|
||||
name of repository to limit backup to
|
||||
-P, --private include private repositories [*]
|
||||
-F, --fork include forked repositories [*]
|
||||
@@ -128,16 +133,16 @@ CLI Help output::
|
||||
--releases include release information, not including assets or
|
||||
binaries
|
||||
--latest-releases NUMBER_OF_LATEST_RELEASES
|
||||
include certain number of the latest releases;
|
||||
only applies if including releases
|
||||
--skip-prerelease skip prerelease and draft versions; only applies if including releases
|
||||
include certain number of the latest releases; only
|
||||
applies if including releases
|
||||
--skip-prerelease skip prerelease and draft versions; only applies if
|
||||
including releases
|
||||
--assets include assets alongside release information; only
|
||||
applies if including releases
|
||||
--attachments download user-attachments from issues and pull requests
|
||||
to issues/attachments/{issue_number}/ and
|
||||
pulls/attachments/{pull_number}/ directories
|
||||
--exclude [REPOSITORY [REPOSITORY ...]]
|
||||
names of repositories to exclude from backup.
|
||||
--skip-assets-on [SKIP_ASSETS_ON ...]
|
||||
skip asset downloads for these repositories
|
||||
--attachments download user-attachments from issues and pull
|
||||
requests
|
||||
--throttle-limit THROTTLE_LIMIT
|
||||
start throttling of GitHub API requests after this
|
||||
amount of API requests remain
|
||||
@@ -145,6 +150,8 @@ CLI Help output::
|
||||
wait this amount of seconds when API request
|
||||
throttling is active (default: 30.0, requires
|
||||
--throttle-limit to be set)
|
||||
--exclude [EXCLUDE ...]
|
||||
names of repositories to exclude
|
||||
|
||||
|
||||
Usage Details
|
||||
@@ -153,13 +160,13 @@ Usage Details
|
||||
Authentication
|
||||
--------------
|
||||
|
||||
**Password-based authentication** will fail if you have two-factor authentication enabled, and will `be deprecated <https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13/>`_ by 2023 EOY.
|
||||
GitHub requires token-based authentication for API access. Password authentication was `removed in November 2020 <https://developer.github.com/changes/2020-02-14-deprecating-password-auth/>`_.
|
||||
|
||||
``--username`` is used for basic password authentication and separate from the positional argument ``USER``, which specifies the user account you wish to back up.
|
||||
The positional argument ``USER`` specifies the user or organization account you wish to back up.
|
||||
|
||||
**Classic tokens** are `slightly less secure <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic>`_ as they provide very coarse-grained permissions.
|
||||
**Fine-grained tokens** (``-f TOKEN_FINE``) are recommended for most use cases, especially long-running backups (e.g. cron jobs), as they provide precise permission control.
|
||||
|
||||
If you need authentication for long-running backups (e.g. for a cron job) it is recommended to use **fine-grained personal access token** ``-f TOKEN_FINE``.
|
||||
**Classic tokens** (``-t TOKEN``) are `slightly less secure <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic>`_ as they provide very coarse-grained permissions.
|
||||
|
||||
|
||||
Fine Tokens
|
||||
@@ -174,6 +181,37 @@ Customise the permissions for your use case, but for a personal account full bac
|
||||
**Repository permissions**: Read access to contents, issues, metadata, pull requests, and webhooks.
|
||||
|
||||
|
||||
GitHub Apps
|
||||
~~~~~~~~~~~
|
||||
|
||||
GitHub Apps are ideal for organization backups in CI/CD. Tokens are scoped to specific repositories and expire after 1 hour.
|
||||
|
||||
**One-time setup:**
|
||||
|
||||
1. Create a GitHub App at *Settings -> Developer Settings -> GitHub Apps -> New GitHub App*
|
||||
2. Set a name and homepage URL (can be any URL)
|
||||
3. Uncheck "Webhook > Active" (not needed for backups)
|
||||
4. Set permissions (same as fine-grained tokens above)
|
||||
5. Click "Create GitHub App", then note the **App ID** shown on the next page
|
||||
6. Under "Private keys", click "Generate a private key" and save the downloaded file
|
||||
7. Go to *Install App* in your app's settings
|
||||
8. Select the account/organization and which repositories to back up
|
||||
|
||||
**CI/CD usage with GitHub Actions:**
|
||||
|
||||
Store the App ID as a repository variable and the private key contents as a secret, then use ``actions/create-github-app-token``::
|
||||
|
||||
- uses: actions/create-github-app-token@v1
|
||||
id: app-token
|
||||
with:
|
||||
app-id: ${{ vars.APP_ID }}
|
||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||
|
||||
- run: github-backup myorg -t ${{ steps.app-token.outputs.token }} --as-app -o ./backup --all
|
||||
|
||||
Note: Installation tokens expire after 1 hour. For long-running backups, use a fine-grained personal access token instead.
|
||||
|
||||
|
||||
Prefer SSH
|
||||
~~~~~~~~~~
|
||||
|
||||
@@ -215,6 +253,8 @@ When you use the ``--lfs`` option, you will need to make sure you have Git LFS i
|
||||
|
||||
Instructions on how to do this can be found on https://git-lfs.github.com.
|
||||
|
||||
LFS objects are fetched for all refs, not just the current checkout, ensuring a complete backup of all LFS content across all branches and history.
|
||||
|
||||
|
||||
About Attachments
|
||||
-----------------
|
||||
@@ -254,10 +294,20 @@ All is not everything
|
||||
|
||||
The ``--all`` argument does not include: cloning private repos (``-P, --private``), cloning forks (``-F, --fork``), cloning starred repositories (``--all-starred``), ``--pull-details``, cloning LFS repositories (``--lfs``), cloning gists (``--gists``) or cloning starred gist repos (``--starred-gists``). See examples for more.
|
||||
|
||||
Cloning all starred size
|
||||
------------------------
|
||||
Starred repository size
|
||||
-----------------------
|
||||
|
||||
Using the ``--all-starred`` argument to clone all starred repositories may use a large amount of storage space, especially if ``--all`` or more arguments are used. e.g. commonly starred repos can have tens of thousands of issues, many large assets and the repo itself etc. Consider just storing links to starred repos in JSON format with ``--starred``.
|
||||
Using the ``--all-starred`` argument to clone all starred repositories may use a large amount of storage space.
|
||||
|
||||
To see your starred repositories sorted by size (requires `GitHub CLI <https://cli.github.com>`_)::
|
||||
|
||||
gh api user/starred --paginate --jq 'sort_by(-.size)[]|"\(.full_name) \(.size/1024|round)MB"'
|
||||
|
||||
To limit which starred repositories are cloned, use ``--starred-skip-size-over SIZE`` where SIZE is in MB. For example, ``--starred-skip-size-over 500`` will skip any starred repository where the git repository size (code and history) exceeds 500 MB. Note that this size limit only applies to the repository itself, not issues, release assets or other metadata. This filter only affects starred repositories; your own repositories are always included regardless of size.
|
||||
|
||||
For finer control, avoid using ``--assets`` with starred repos, or use ``--skip-assets-on`` for specific repositories with large release binaries.
|
||||
|
||||
Alternatively, consider just storing links to starred repos in JSON format with ``--starred``.
|
||||
|
||||
Incremental Backup
|
||||
------------------
|
||||
@@ -281,11 +331,11 @@ If the incremental argument is used, this will result in the next backup only re
|
||||
|
||||
It's therefore recommended to only use the incremental argument if the output/result is being actively monitored, or complimented with periodic full non-incremental runs, to avoid unexpected missing data in a regular backup runs.
|
||||
|
||||
1. **Starred public repo hooks blocking**
|
||||
**Starred public repo hooks blocking**
|
||||
|
||||
Since the ``--all`` argument includes ``--hooks``, if you use ``--all`` and ``--all-starred`` together to clone a users starred public repositories, the backup will likely error and block the backup continuing.
|
||||
Since the ``--all`` argument includes ``--hooks``, if you use ``--all`` and ``--all-starred`` together to clone a users starred public repositories, the backup will likely error and block the backup continuing.
|
||||
|
||||
This is due to needing the correct permission for ``--hooks`` on public repos.
|
||||
This is due to needing the correct permission for ``--hooks`` on public repos.
|
||||
|
||||
|
||||
"bare" is actually "mirror"
|
||||
@@ -301,6 +351,8 @@ Starred gists vs starred repo behaviour
|
||||
|
||||
The starred normal repo cloning (``--all-starred``) argument stores starred repos separately to the users own repositories. However, using ``--starred-gists`` will store starred gists within the same directory as the users own gists ``--gists``. Also, all gist repo directory names are IDs not the gist's name.
|
||||
|
||||
Note: ``--starred-gists`` only retrieves starred gists for the authenticated user, not the target user, due to a GitHub API limitation.
|
||||
|
||||
|
||||
Skip existing on incomplete backups
|
||||
-----------------------------------
|
||||
@@ -308,6 +360,25 @@ Skip existing on incomplete backups
|
||||
The ``--skip-existing`` argument will skip a backup if the directory already exists, even if the backup in that directory failed (perhaps due to a blocking error). This may result in unexpected missing data in a regular backup.
|
||||
|
||||
|
||||
Updates use fetch, not pull
|
||||
---------------------------
|
||||
|
||||
When updating an existing repository backup, ``github-backup`` uses ``git fetch`` rather than ``git pull``. This is intentional - a backup tool should reliably download data without risk of failure. Using ``git pull`` would require handling merge conflicts, which adds complexity and could cause backups to fail unexpectedly.
|
||||
|
||||
With fetch, **all branches and commits are downloaded** safely into remote-tracking branches. The working directory files won't change, but your backup is complete.
|
||||
|
||||
If you look at files directly (e.g., ``cat README.md``), you'll see the old content. The new data is in the remote-tracking branches (confusingly named "remote" but stored locally). To view or use the latest files::
|
||||
|
||||
git show origin/main:README.md # view a file
|
||||
git merge origin/main # update working directory
|
||||
|
||||
All branches are backed up as remote refs (``origin/main``, ``origin/feature-branch``, etc.).
|
||||
|
||||
If you want to browse files directly without merging, consider using ``--bare`` which skips the working directory entirely - the backup is just the git data.
|
||||
|
||||
See `#269 <https://github.com/josegonzalez/python-github-backup/issues/269>`_ for more discussion.
|
||||
|
||||
|
||||
Github Backup Examples
|
||||
======================
|
||||
|
||||
@@ -338,6 +409,28 @@ Debug an error/block or incomplete backup into a temporary directory. Omit "incr
|
||||
|
||||
github-backup -f $FINE_ACCESS_TOKEN -o /tmp/github-backup/ -l debug -P --all-starred --starred --watched --followers --following --issues --issue-comments --issue-events --pulls --pull-comments --pull-commits --labels --milestones --repositories --wikis --releases --assets --pull-details --gists --starred-gists $GH_USER
|
||||
|
||||
Pipe a token from stdin to avoid storing it in environment variables or command history (Unix-like systems only)::
|
||||
|
||||
my-secret-manager get github-token | github-backup user -t file:///dev/stdin -o /backup --repositories
|
||||
|
||||
Restoring from Backup
|
||||
=====================
|
||||
|
||||
This tool creates backups only, there is no inbuilt restore command.
|
||||
|
||||
**Git repositories, wikis, and gists** can be restored by pushing them back to GitHub as you would any git repository. For example, to restore a bare repository backup::
|
||||
|
||||
cd /tmp/white-house/repositories/petitions/repository
|
||||
git push --mirror git@github.com:WhiteHouse/petitions.git
|
||||
|
||||
**Issues, pull requests, comments, and other metadata** are saved as JSON files for archival purposes. The GitHub API does not support recreating this data faithfully, creating issues via the API has limitations:
|
||||
|
||||
- New issue/PR numbers are assigned (original numbers cannot be set)
|
||||
- Timestamps reflect creation time (original dates cannot be set)
|
||||
- The API caller becomes the author (original authors cannot be set)
|
||||
- Cross-references between issues and PRs will break
|
||||
|
||||
These are GitHub API limitations that affect all backup and migration tools, not just this one. Recreating issues with these limitations via the GitHub API is an exercise for the reader. The JSON backups remain useful for searching, auditing, or manual reference.
|
||||
|
||||
|
||||
Development
|
||||
@@ -357,7 +450,12 @@ A huge thanks to all the contibuters!
|
||||
Testing
|
||||
-------
|
||||
|
||||
This project currently contains no unit tests. To run linting::
|
||||
To run the test suite::
|
||||
|
||||
pip install pytest
|
||||
pytest
|
||||
|
||||
To run linting::
|
||||
|
||||
pip install flake8
|
||||
flake8 --ignore=E501
|
||||
|
||||
@@ -1,58 +1,18 @@
|
||||
#!/usr/bin/env python
|
||||
"""
|
||||
Backwards-compatible wrapper script.
|
||||
|
||||
The recommended way to run github-backup is via the installed command
|
||||
(pip install github-backup) or python -m github_backup.
|
||||
|
||||
This script is kept for backwards compatibility with existing installations
|
||||
that may reference this path directly.
|
||||
"""
|
||||
|
||||
import logging
|
||||
import os
|
||||
import sys
|
||||
|
||||
from github_backup.github_backup import (
|
||||
backup_account,
|
||||
backup_repositories,
|
||||
check_git_lfs_install,
|
||||
filter_repositories,
|
||||
get_authenticated_user,
|
||||
logger,
|
||||
mkdir_p,
|
||||
parse_args,
|
||||
retrieve_repositories,
|
||||
)
|
||||
|
||||
logging.basicConfig(
|
||||
format="%(asctime)s.%(msecs)03d: %(message)s",
|
||||
datefmt="%Y-%m-%dT%H:%M:%S",
|
||||
level=logging.INFO,
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
args = parse_args()
|
||||
|
||||
if args.quiet:
|
||||
logger.setLevel(logging.WARNING)
|
||||
|
||||
output_directory = os.path.realpath(args.output_directory)
|
||||
if not os.path.isdir(output_directory):
|
||||
logger.info("Create output directory {0}".format(output_directory))
|
||||
mkdir_p(output_directory)
|
||||
|
||||
if args.lfs_clone:
|
||||
check_git_lfs_install()
|
||||
|
||||
if args.log_level:
|
||||
log_level = logging.getLevelName(args.log_level.upper())
|
||||
if isinstance(log_level, int):
|
||||
logger.root.setLevel(log_level)
|
||||
|
||||
if not args.as_app:
|
||||
logger.info("Backing up user {0} to {1}".format(args.user, output_directory))
|
||||
authenticated_user = get_authenticated_user(args)
|
||||
else:
|
||||
authenticated_user = {"login": None}
|
||||
|
||||
repositories = retrieve_repositories(args, authenticated_user)
|
||||
repositories = filter_repositories(args, repositories)
|
||||
backup_repositories(args, output_directory, repositories)
|
||||
backup_account(args, output_directory)
|
||||
|
||||
from github_backup.cli import main
|
||||
from github_backup.github_backup import logger
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
|
||||
@@ -1 +1 @@
|
||||
__version__ = "0.51.1"
|
||||
__version__ = "0.59.0"
|
||||
|
||||
13
github_backup/__main__.py
Normal file
13
github_backup/__main__.py
Normal file
@@ -0,0 +1,13 @@
|
||||
"""Allow running as: python -m github_backup"""
|
||||
|
||||
import sys
|
||||
|
||||
from github_backup.cli import main
|
||||
from github_backup.github_backup import logger
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
main()
|
||||
except Exception as e:
|
||||
logger.error(str(e))
|
||||
sys.exit(1)
|
||||
82
github_backup/cli.py
Normal file
82
github_backup/cli.py
Normal file
@@ -0,0 +1,82 @@
|
||||
#!/usr/bin/env python
|
||||
"""Command-line interface for github-backup."""
|
||||
|
||||
import logging
|
||||
import os
|
||||
import sys
|
||||
|
||||
from github_backup.github_backup import (
|
||||
backup_account,
|
||||
backup_repositories,
|
||||
check_git_lfs_install,
|
||||
filter_repositories,
|
||||
get_auth,
|
||||
get_authenticated_user,
|
||||
logger,
|
||||
mkdir_p,
|
||||
parse_args,
|
||||
retrieve_repositories,
|
||||
)
|
||||
|
||||
# INFO and DEBUG go to stdout, WARNING and above go to stderr
|
||||
log_format = logging.Formatter(
|
||||
fmt="%(asctime)s.%(msecs)03d: %(message)s",
|
||||
datefmt="%Y-%m-%dT%H:%M:%S",
|
||||
)
|
||||
|
||||
stdout_handler = logging.StreamHandler(sys.stdout)
|
||||
stdout_handler.setLevel(logging.DEBUG)
|
||||
stdout_handler.addFilter(lambda r: r.levelno < logging.WARNING)
|
||||
stdout_handler.setFormatter(log_format)
|
||||
|
||||
stderr_handler = logging.StreamHandler(sys.stderr)
|
||||
stderr_handler.setLevel(logging.WARNING)
|
||||
stderr_handler.setFormatter(log_format)
|
||||
|
||||
logging.basicConfig(level=logging.INFO, handlers=[stdout_handler, stderr_handler])
|
||||
|
||||
|
||||
def main():
|
||||
"""Main entry point for github-backup CLI."""
|
||||
args = parse_args()
|
||||
|
||||
if args.private and not get_auth(args):
|
||||
logger.warning(
|
||||
"The --private flag has no effect without authentication. "
|
||||
"Use -t/--token or -f/--token-fine to authenticate."
|
||||
)
|
||||
|
||||
if args.quiet:
|
||||
logger.setLevel(logging.WARNING)
|
||||
|
||||
output_directory = os.path.realpath(args.output_directory)
|
||||
if not os.path.isdir(output_directory):
|
||||
logger.info("Create output directory {0}".format(output_directory))
|
||||
mkdir_p(output_directory)
|
||||
|
||||
if args.lfs_clone:
|
||||
check_git_lfs_install()
|
||||
|
||||
if args.log_level:
|
||||
log_level = logging.getLevelName(args.log_level.upper())
|
||||
if isinstance(log_level, int):
|
||||
logger.root.setLevel(log_level)
|
||||
|
||||
if not args.as_app:
|
||||
logger.info("Backing up user {0} to {1}".format(args.user, output_directory))
|
||||
authenticated_user = get_authenticated_user(args)
|
||||
else:
|
||||
authenticated_user = {"login": None}
|
||||
|
||||
repositories = retrieve_repositories(args, authenticated_user)
|
||||
repositories = filter_repositories(args, repositories)
|
||||
backup_repositories(args, output_directory, repositories)
|
||||
backup_account(args, output_directory)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
main()
|
||||
except Exception as e:
|
||||
logger.error(str(e))
|
||||
sys.exit(1)
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,40 +1,15 @@
|
||||
# Linting & Formatting
|
||||
autopep8==2.3.2
|
||||
black==25.11.0
|
||||
bleach==6.3.0
|
||||
certifi==2025.11.12
|
||||
charset-normalizer==3.4.4
|
||||
click==8.3.0
|
||||
colorama==0.4.6
|
||||
docutils==0.22.3
|
||||
black==25.12.0
|
||||
flake8==7.3.0
|
||||
gitchangelog==3.0.4
|
||||
pytest==8.3.3
|
||||
idna==3.11
|
||||
importlib-metadata==8.7.0
|
||||
jaraco.classes==3.4.0
|
||||
keyring==25.6.0
|
||||
markdown-it-py==4.0.0
|
||||
mccabe==0.7.0
|
||||
mdurl==0.1.2
|
||||
more-itertools==10.8.0
|
||||
mypy-extensions==1.1.0
|
||||
packaging==25.0
|
||||
pathspec==0.12.1
|
||||
pkginfo==1.12.1.2
|
||||
platformdirs==4.5.0
|
||||
pycodestyle==2.14.0
|
||||
pyflakes==3.4.0
|
||||
Pygments==2.19.2
|
||||
readme-renderer==44.0
|
||||
requests==2.32.5
|
||||
requests-toolbelt==1.0.0
|
||||
restructuredtext-lint==1.4.0
|
||||
rfc3986==2.0.0
|
||||
rich==14.2.0
|
||||
setuptools==80.9.0
|
||||
six==1.17.0
|
||||
tqdm==4.67.1
|
||||
|
||||
# Testing
|
||||
pytest==9.0.2
|
||||
|
||||
# Release & Publishing
|
||||
twine==6.2.0
|
||||
urllib3==2.5.0
|
||||
webencodings==0.5.1
|
||||
zipp==3.23.0
|
||||
gitchangelog==3.0.4
|
||||
setuptools==80.9.0
|
||||
|
||||
# Documentation
|
||||
restructuredtext-lint==2.0.2
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
|
||||
|
||||
6
setup.py
6
setup.py
@@ -33,7 +33,11 @@ setup(
|
||||
author="Jose Diaz-Gonzalez",
|
||||
author_email="github-backup@josediazgonzalez.com",
|
||||
packages=["github_backup"],
|
||||
scripts=["bin/github-backup"],
|
||||
entry_points={
|
||||
"console_scripts": [
|
||||
"github-backup=github_backup.cli:main",
|
||||
],
|
||||
},
|
||||
url="http://github.com/josegonzalez/python-github-backup",
|
||||
license="MIT",
|
||||
classifiers=[
|
||||
|
||||
159
tests/test_all_starred.py
Normal file
159
tests/test_all_starred.py
Normal file
@@ -0,0 +1,159 @@
|
||||
"""Tests for --all-starred flag behavior (issue #225)."""
|
||||
|
||||
import pytest
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
from github_backup import github_backup
|
||||
|
||||
|
||||
class TestAllStarredCloning:
|
||||
"""Test suite for --all-starred repository cloning behavior.
|
||||
|
||||
Issue #225: --all-starred should clone starred repos without requiring --repositories.
|
||||
"""
|
||||
|
||||
def _create_mock_args(self, **overrides):
|
||||
"""Create a mock args object with sensible defaults."""
|
||||
args = Mock()
|
||||
args.user = "testuser"
|
||||
args.output_directory = "/tmp/backup"
|
||||
args.include_repository = False
|
||||
args.include_everything = False
|
||||
args.include_gists = False
|
||||
args.include_starred_gists = False
|
||||
args.all_starred = False
|
||||
args.skip_existing = False
|
||||
args.bare_clone = False
|
||||
args.lfs_clone = False
|
||||
args.no_prune = False
|
||||
args.include_wiki = False
|
||||
args.include_issues = False
|
||||
args.include_issue_comments = False
|
||||
args.include_issue_events = False
|
||||
args.include_pulls = False
|
||||
args.include_pull_comments = False
|
||||
args.include_pull_commits = False
|
||||
args.include_pull_details = False
|
||||
args.include_labels = False
|
||||
args.include_hooks = False
|
||||
args.include_milestones = False
|
||||
args.include_releases = False
|
||||
args.include_assets = False
|
||||
args.include_attachments = False
|
||||
args.incremental = False
|
||||
args.incremental_by_files = False
|
||||
args.github_host = None
|
||||
args.prefer_ssh = False
|
||||
args.token_classic = None
|
||||
args.token_fine = None
|
||||
args.as_app = False
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
|
||||
for key, value in overrides.items():
|
||||
setattr(args, key, value)
|
||||
|
||||
return args
|
||||
|
||||
@patch('github_backup.github_backup.fetch_repository')
|
||||
@patch('github_backup.github_backup.get_github_repo_url')
|
||||
def test_all_starred_clones_without_repositories_flag(self, mock_get_url, mock_fetch):
|
||||
"""--all-starred should clone starred repos without --repositories flag.
|
||||
|
||||
This is the core fix for issue #225.
|
||||
"""
|
||||
args = self._create_mock_args(all_starred=True)
|
||||
mock_get_url.return_value = "https://github.com/otheruser/awesome-project.git"
|
||||
|
||||
# A starred repository (is_starred flag set by retrieve_repositories)
|
||||
starred_repo = {
|
||||
"name": "awesome-project",
|
||||
"full_name": "otheruser/awesome-project",
|
||||
"owner": {"login": "otheruser"},
|
||||
"private": False,
|
||||
"fork": False,
|
||||
"has_wiki": False,
|
||||
"is_starred": True, # This flag is set for starred repos
|
||||
}
|
||||
|
||||
with patch('github_backup.github_backup.mkdir_p'):
|
||||
github_backup.backup_repositories(args, "/tmp/backup", [starred_repo])
|
||||
|
||||
# fetch_repository should be called for the starred repo
|
||||
assert mock_fetch.called, "--all-starred should trigger repository cloning"
|
||||
mock_fetch.assert_called_once()
|
||||
call_args = mock_fetch.call_args
|
||||
assert call_args[0][0] == "awesome-project" # repo name
|
||||
|
||||
@patch('github_backup.github_backup.fetch_repository')
|
||||
@patch('github_backup.github_backup.get_github_repo_url')
|
||||
def test_starred_repo_not_cloned_without_all_starred_flag(self, mock_get_url, mock_fetch):
|
||||
"""Starred repos should NOT be cloned if --all-starred is not set."""
|
||||
args = self._create_mock_args(all_starred=False)
|
||||
mock_get_url.return_value = "https://github.com/otheruser/awesome-project.git"
|
||||
|
||||
starred_repo = {
|
||||
"name": "awesome-project",
|
||||
"full_name": "otheruser/awesome-project",
|
||||
"owner": {"login": "otheruser"},
|
||||
"private": False,
|
||||
"fork": False,
|
||||
"has_wiki": False,
|
||||
"is_starred": True,
|
||||
}
|
||||
|
||||
with patch('github_backup.github_backup.mkdir_p'):
|
||||
github_backup.backup_repositories(args, "/tmp/backup", [starred_repo])
|
||||
|
||||
# fetch_repository should NOT be called
|
||||
assert not mock_fetch.called, "Starred repos should not be cloned without --all-starred"
|
||||
|
||||
@patch('github_backup.github_backup.fetch_repository')
|
||||
@patch('github_backup.github_backup.get_github_repo_url')
|
||||
def test_non_starred_repo_not_cloned_with_only_all_starred(self, mock_get_url, mock_fetch):
|
||||
"""Non-starred repos should NOT be cloned when only --all-starred is set."""
|
||||
args = self._create_mock_args(all_starred=True)
|
||||
mock_get_url.return_value = "https://github.com/testuser/my-project.git"
|
||||
|
||||
# A regular (non-starred) repository
|
||||
regular_repo = {
|
||||
"name": "my-project",
|
||||
"full_name": "testuser/my-project",
|
||||
"owner": {"login": "testuser"},
|
||||
"private": False,
|
||||
"fork": False,
|
||||
"has_wiki": False,
|
||||
# No is_starred flag
|
||||
}
|
||||
|
||||
with patch('github_backup.github_backup.mkdir_p'):
|
||||
github_backup.backup_repositories(args, "/tmp/backup", [regular_repo])
|
||||
|
||||
# fetch_repository should NOT be called for non-starred repos
|
||||
assert not mock_fetch.called, "Non-starred repos should not be cloned with only --all-starred"
|
||||
|
||||
@patch('github_backup.github_backup.fetch_repository')
|
||||
@patch('github_backup.github_backup.get_github_repo_url')
|
||||
def test_repositories_flag_still_works(self, mock_get_url, mock_fetch):
|
||||
"""--repositories flag should still clone repos as before."""
|
||||
args = self._create_mock_args(include_repository=True)
|
||||
mock_get_url.return_value = "https://github.com/testuser/my-project.git"
|
||||
|
||||
regular_repo = {
|
||||
"name": "my-project",
|
||||
"full_name": "testuser/my-project",
|
||||
"owner": {"login": "testuser"},
|
||||
"private": False,
|
||||
"fork": False,
|
||||
"has_wiki": False,
|
||||
}
|
||||
|
||||
with patch('github_backup.github_backup.mkdir_p'):
|
||||
github_backup.backup_repositories(args, "/tmp/backup", [regular_repo])
|
||||
|
||||
# fetch_repository should be called
|
||||
assert mock_fetch.called, "--repositories should trigger repository cloning"
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
pytest.main([__file__, "-v"])
|
||||
@@ -24,8 +24,6 @@ def attachment_test_setup(tmp_path):
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = None
|
||||
args.username = None
|
||||
args.password = None
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.user = "testuser"
|
||||
|
||||
118
tests/test_case_sensitivity.py
Normal file
118
tests/test_case_sensitivity.py
Normal file
@@ -0,0 +1,118 @@
|
||||
"""Tests for case-insensitive username/organization filtering."""
|
||||
|
||||
import pytest
|
||||
from unittest.mock import Mock
|
||||
|
||||
from github_backup import github_backup
|
||||
|
||||
|
||||
class TestCaseSensitivity:
|
||||
"""Test suite for case-insensitive username matching in filter_repositories."""
|
||||
|
||||
def test_filter_repositories_case_insensitive_user(self):
|
||||
"""Should filter repositories case-insensitively for usernames.
|
||||
|
||||
Reproduces issue #198 where typing 'iamrodos' fails to match
|
||||
repositories with owner.login='Iamrodos' (the canonical case from GitHub API).
|
||||
"""
|
||||
# Simulate user typing lowercase username
|
||||
args = Mock()
|
||||
args.user = "iamrodos" # lowercase (what user typed)
|
||||
args.repository = None
|
||||
args.name_regex = None
|
||||
args.languages = None
|
||||
args.exclude = None
|
||||
args.fork = False
|
||||
args.private = False
|
||||
args.public = False
|
||||
args.all = True
|
||||
args.skip_archived = False
|
||||
args.starred_skip_size_over = None
|
||||
|
||||
# Simulate GitHub API returning canonical case
|
||||
repos = [
|
||||
{
|
||||
"name": "repo1",
|
||||
"owner": {"login": "Iamrodos"}, # Capital I (canonical from API)
|
||||
"private": False,
|
||||
"fork": False,
|
||||
},
|
||||
{
|
||||
"name": "repo2",
|
||||
"owner": {"login": "Iamrodos"},
|
||||
"private": False,
|
||||
"fork": False,
|
||||
},
|
||||
]
|
||||
|
||||
filtered = github_backup.filter_repositories(args, repos)
|
||||
|
||||
# Should match despite case difference
|
||||
assert len(filtered) == 2
|
||||
assert filtered[0]["name"] == "repo1"
|
||||
assert filtered[1]["name"] == "repo2"
|
||||
|
||||
def test_filter_repositories_case_insensitive_org(self):
|
||||
"""Should filter repositories case-insensitively for organizations.
|
||||
|
||||
Tests the example from issue #198 where 'prai-org' doesn't match 'PRAI-Org'.
|
||||
"""
|
||||
args = Mock()
|
||||
args.user = "prai-org" # lowercase (what user typed)
|
||||
args.repository = None
|
||||
args.name_regex = None
|
||||
args.languages = None
|
||||
args.exclude = None
|
||||
args.fork = False
|
||||
args.private = False
|
||||
args.public = False
|
||||
args.all = True
|
||||
args.skip_archived = False
|
||||
args.starred_skip_size_over = None
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "repo1",
|
||||
"owner": {"login": "PRAI-Org"}, # Different case (canonical from API)
|
||||
"private": False,
|
||||
"fork": False,
|
||||
},
|
||||
]
|
||||
|
||||
filtered = github_backup.filter_repositories(args, repos)
|
||||
|
||||
# Should match despite case difference
|
||||
assert len(filtered) == 1
|
||||
assert filtered[0]["name"] == "repo1"
|
||||
|
||||
def test_filter_repositories_case_variations(self):
|
||||
"""Should handle various case combinations correctly."""
|
||||
args = Mock()
|
||||
args.user = "TeSt-UsEr" # Mixed case
|
||||
args.repository = None
|
||||
args.name_regex = None
|
||||
args.languages = None
|
||||
args.exclude = None
|
||||
args.fork = False
|
||||
args.private = False
|
||||
args.public = False
|
||||
args.all = True
|
||||
args.skip_archived = False
|
||||
args.starred_skip_size_over = None
|
||||
|
||||
repos = [
|
||||
{"name": "repo1", "owner": {"login": "test-user"}, "private": False, "fork": False},
|
||||
{"name": "repo2", "owner": {"login": "TEST-USER"}, "private": False, "fork": False},
|
||||
{"name": "repo3", "owner": {"login": "TeSt-UsEr"}, "private": False, "fork": False},
|
||||
{"name": "repo4", "owner": {"login": "other-user"}, "private": False, "fork": False},
|
||||
]
|
||||
|
||||
filtered = github_backup.filter_repositories(args, repos)
|
||||
|
||||
# Should match first 3 (all case variations of same user)
|
||||
assert len(filtered) == 3
|
||||
assert set(r["name"] for r in filtered) == {"repo1", "repo2", "repo3"}
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
pytest.main([__file__, "-v"])
|
||||
94
tests/test_http_451.py
Normal file
94
tests/test_http_451.py
Normal file
@@ -0,0 +1,94 @@
|
||||
"""Tests for HTTP 451 (DMCA takedown) handling."""
|
||||
|
||||
import json
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from github_backup import github_backup
|
||||
|
||||
|
||||
class TestHTTP451Exception:
|
||||
"""Test suite for HTTP 451 DMCA takedown exception handling."""
|
||||
|
||||
def test_repository_unavailable_error_raised(self):
|
||||
"""HTTP 451 should raise RepositoryUnavailableError with DMCA URL."""
|
||||
args = Mock()
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = None
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.throttle_limit = None
|
||||
args.throttle_pause = 0
|
||||
|
||||
mock_response = Mock()
|
||||
mock_response.getcode.return_value = 451
|
||||
|
||||
dmca_data = {
|
||||
"message": "Repository access blocked",
|
||||
"block": {
|
||||
"reason": "dmca",
|
||||
"created_at": "2024-11-12T14:38:04Z",
|
||||
"html_url": "https://github.com/github/dmca/blob/master/2024/11/2024-11-04-source-code.md"
|
||||
}
|
||||
}
|
||||
mock_response.read.return_value = json.dumps(dmca_data).encode("utf-8")
|
||||
mock_response.headers = {"x-ratelimit-remaining": "5000"}
|
||||
mock_response.reason = "Unavailable For Legal Reasons"
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
|
||||
with pytest.raises(github_backup.RepositoryUnavailableError) as exc_info:
|
||||
github_backup.retrieve_data(args, "https://api.github.com/repos/test/dmca/issues")
|
||||
|
||||
assert exc_info.value.dmca_url == "https://github.com/github/dmca/blob/master/2024/11/2024-11-04-source-code.md"
|
||||
assert "451" in str(exc_info.value)
|
||||
|
||||
def test_repository_unavailable_error_without_dmca_url(self):
|
||||
"""HTTP 451 without DMCA details should still raise exception."""
|
||||
args = Mock()
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = None
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.throttle_limit = None
|
||||
args.throttle_pause = 0
|
||||
|
||||
mock_response = Mock()
|
||||
mock_response.getcode.return_value = 451
|
||||
mock_response.read.return_value = b'{"message": "Blocked"}'
|
||||
mock_response.headers = {"x-ratelimit-remaining": "5000"}
|
||||
mock_response.reason = "Unavailable For Legal Reasons"
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
|
||||
with pytest.raises(github_backup.RepositoryUnavailableError) as exc_info:
|
||||
github_backup.retrieve_data(args, "https://api.github.com/repos/test/dmca/issues")
|
||||
|
||||
assert exc_info.value.dmca_url is None
|
||||
assert "451" in str(exc_info.value)
|
||||
|
||||
def test_repository_unavailable_error_with_malformed_json(self):
|
||||
"""HTTP 451 with malformed JSON should still raise exception."""
|
||||
args = Mock()
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = None
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.throttle_limit = None
|
||||
args.throttle_pause = 0
|
||||
|
||||
mock_response = Mock()
|
||||
mock_response.getcode.return_value = 451
|
||||
mock_response.read.return_value = b"invalid json {"
|
||||
mock_response.headers = {"x-ratelimit-remaining": "5000"}
|
||||
mock_response.reason = "Unavailable For Legal Reasons"
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
|
||||
with pytest.raises(github_backup.RepositoryUnavailableError):
|
||||
github_backup.retrieve_data(args, "https://api.github.com/repos/test/dmca/issues")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
pytest.main([__file__, "-v"])
|
||||
198
tests/test_json_dump_if_changed.py
Normal file
198
tests/test_json_dump_if_changed.py
Normal file
@@ -0,0 +1,198 @@
|
||||
"""Tests for json_dump_if_changed functionality."""
|
||||
|
||||
import codecs
|
||||
import json
|
||||
import os
|
||||
import tempfile
|
||||
|
||||
import pytest
|
||||
|
||||
from github_backup import github_backup
|
||||
|
||||
|
||||
class TestJsonDumpIfChanged:
|
||||
"""Test suite for json_dump_if_changed function."""
|
||||
|
||||
def test_writes_new_file(self):
|
||||
"""Should write file when it doesn't exist."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data = {"key": "value", "number": 42}
|
||||
|
||||
result = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
|
||||
assert result is True
|
||||
assert os.path.exists(output_file)
|
||||
|
||||
# Verify content matches expected format
|
||||
with codecs.open(output_file, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
loaded = json.loads(content)
|
||||
assert loaded == test_data
|
||||
|
||||
def test_skips_unchanged_file(self):
|
||||
"""Should skip write when content is identical."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data = {"key": "value", "number": 42}
|
||||
|
||||
# First write
|
||||
result1 = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
assert result1 is True
|
||||
|
||||
# Get the initial mtime
|
||||
mtime1 = os.path.getmtime(output_file)
|
||||
|
||||
# Second write with same data
|
||||
result2 = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
assert result2 is False
|
||||
|
||||
# File should not have been modified
|
||||
mtime2 = os.path.getmtime(output_file)
|
||||
assert mtime1 == mtime2
|
||||
|
||||
def test_writes_when_content_changed(self):
|
||||
"""Should write file when content has changed."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data1 = {"key": "value1"}
|
||||
test_data2 = {"key": "value2"}
|
||||
|
||||
# First write
|
||||
result1 = github_backup.json_dump_if_changed(test_data1, output_file)
|
||||
assert result1 is True
|
||||
|
||||
# Second write with different data
|
||||
result2 = github_backup.json_dump_if_changed(test_data2, output_file)
|
||||
assert result2 is True
|
||||
|
||||
# Verify new content
|
||||
with codecs.open(output_file, "r", encoding="utf-8") as f:
|
||||
loaded = json.load(f)
|
||||
assert loaded == test_data2
|
||||
|
||||
def test_uses_consistent_formatting(self):
|
||||
"""Should use same JSON formatting as json_dump."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data = {"z": "last", "a": "first", "m": "middle"}
|
||||
|
||||
github_backup.json_dump_if_changed(test_data, output_file)
|
||||
|
||||
with codecs.open(output_file, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
|
||||
# Check for consistent formatting:
|
||||
# - sorted keys
|
||||
# - 4-space indent
|
||||
# - comma-colon-space separator
|
||||
expected = json.dumps(
|
||||
test_data,
|
||||
ensure_ascii=False,
|
||||
sort_keys=True,
|
||||
indent=4,
|
||||
separators=(",", ": "),
|
||||
)
|
||||
assert content == expected
|
||||
|
||||
def test_atomic_write_always_used(self):
|
||||
"""Should always use temp file and rename for atomic writes."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data = {"key": "value"}
|
||||
|
||||
result = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
|
||||
assert result is True
|
||||
assert os.path.exists(output_file)
|
||||
|
||||
# Temp file should not exist after atomic write
|
||||
temp_file = output_file + ".temp"
|
||||
assert not os.path.exists(temp_file)
|
||||
|
||||
# Verify content
|
||||
with codecs.open(output_file, "r", encoding="utf-8") as f:
|
||||
loaded = json.load(f)
|
||||
assert loaded == test_data
|
||||
|
||||
def test_handles_unicode_content(self):
|
||||
"""Should correctly handle Unicode content."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data = {
|
||||
"emoji": "🚀",
|
||||
"chinese": "你好",
|
||||
"arabic": "مرحبا",
|
||||
"cyrillic": "Привет",
|
||||
}
|
||||
|
||||
result = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
assert result is True
|
||||
|
||||
# Verify Unicode is preserved
|
||||
with codecs.open(output_file, "r", encoding="utf-8") as f:
|
||||
loaded = json.load(f)
|
||||
assert loaded == test_data
|
||||
|
||||
# Second write should skip
|
||||
result2 = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
assert result2 is False
|
||||
|
||||
def test_handles_complex_nested_data(self):
|
||||
"""Should handle complex nested data structures."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data = {
|
||||
"users": [
|
||||
{"id": 1, "name": "Alice", "tags": ["admin", "user"]},
|
||||
{"id": 2, "name": "Bob", "tags": ["user"]},
|
||||
],
|
||||
"metadata": {"version": "1.0", "nested": {"deep": {"value": 42}}},
|
||||
}
|
||||
|
||||
result = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
assert result is True
|
||||
|
||||
# Verify structure is preserved
|
||||
with codecs.open(output_file, "r", encoding="utf-8") as f:
|
||||
loaded = json.load(f)
|
||||
assert loaded == test_data
|
||||
|
||||
def test_overwrites_on_unicode_decode_error(self):
|
||||
"""Should overwrite if existing file has invalid UTF-8."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
test_data = {"key": "value"}
|
||||
|
||||
# Write invalid UTF-8 bytes
|
||||
with open(output_file, "wb") as f:
|
||||
f.write(b"\xff\xfe invalid utf-8")
|
||||
|
||||
# Should catch UnicodeDecodeError and overwrite
|
||||
result = github_backup.json_dump_if_changed(test_data, output_file)
|
||||
assert result is True
|
||||
|
||||
# Verify new content was written
|
||||
with codecs.open(output_file, "r", encoding="utf-8") as f:
|
||||
loaded = json.load(f)
|
||||
assert loaded == test_data
|
||||
|
||||
def test_key_order_independence(self):
|
||||
"""Should treat differently-ordered dicts as same if keys/values match."""
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
output_file = os.path.join(tmpdir, "test.json")
|
||||
|
||||
# Write first dict
|
||||
data1 = {"z": 1, "a": 2, "m": 3}
|
||||
github_backup.json_dump_if_changed(data1, output_file)
|
||||
|
||||
# Try to write same data but different order
|
||||
data2 = {"a": 2, "m": 3, "z": 1}
|
||||
result = github_backup.json_dump_if_changed(data2, output_file)
|
||||
|
||||
# Should skip because content is the same (keys are sorted)
|
||||
assert result is False
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
pytest.main([__file__, "-v"])
|
||||
145
tests/test_pagination.py
Normal file
145
tests/test_pagination.py
Normal file
@@ -0,0 +1,145 @@
|
||||
"""Tests for Link header pagination handling."""
|
||||
|
||||
import json
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from github_backup import github_backup
|
||||
|
||||
|
||||
class MockHTTPResponse:
|
||||
"""Mock HTTP response for paginated API calls."""
|
||||
|
||||
def __init__(self, data, link_header=None):
|
||||
self._content = json.dumps(data).encode("utf-8")
|
||||
self._link_header = link_header
|
||||
self._read = False
|
||||
self.reason = "OK"
|
||||
|
||||
def getcode(self):
|
||||
return 200
|
||||
|
||||
def read(self):
|
||||
if self._read:
|
||||
return b""
|
||||
self._read = True
|
||||
return self._content
|
||||
|
||||
def get_header(self, name, default=None):
|
||||
"""Mock method for headers.get()."""
|
||||
return self.headers.get(name, default)
|
||||
|
||||
@property
|
||||
def headers(self):
|
||||
headers = {"x-ratelimit-remaining": "5000"}
|
||||
if self._link_header:
|
||||
headers["Link"] = self._link_header
|
||||
return headers
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_args():
|
||||
"""Mock args for retrieve_data."""
|
||||
args = Mock()
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = "fake_token"
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.throttle_limit = None
|
||||
args.throttle_pause = 0
|
||||
return args
|
||||
|
||||
|
||||
def test_cursor_based_pagination(mock_args):
|
||||
"""Link header with 'after' cursor parameter works correctly."""
|
||||
|
||||
# Simulate issues endpoint behavior: returns cursor in Link header
|
||||
responses = [
|
||||
# Issues endpoint returns 'after' cursor parameter (not 'page')
|
||||
MockHTTPResponse(
|
||||
data=[{"issue": i} for i in range(1, 101)], # Page 1 contents
|
||||
link_header='<https://api.github.com/repos/owner/repo/issues?per_page=100&after=ABC123&page=2>; rel="next"',
|
||||
),
|
||||
MockHTTPResponse(
|
||||
data=[{"issue": i} for i in range(101, 151)], # Page 2 contents
|
||||
link_header=None, # No Link header - signals end of pagination
|
||||
),
|
||||
]
|
||||
requests_made = []
|
||||
|
||||
def mock_urlopen(request, *args, **kwargs):
|
||||
url = request.get_full_url()
|
||||
requests_made.append(url)
|
||||
return responses[len(requests_made) - 1]
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
results = github_backup.retrieve_data(
|
||||
mock_args, "https://api.github.com/repos/owner/repo/issues"
|
||||
)
|
||||
|
||||
# Verify all items retrieved and cursor was used in second request
|
||||
assert len(results) == 150
|
||||
assert len(requests_made) == 2
|
||||
assert "after=ABC123" in requests_made[1]
|
||||
|
||||
|
||||
def test_page_based_pagination(mock_args):
|
||||
"""Link header with 'page' parameter works correctly."""
|
||||
|
||||
# Simulate pulls/repos endpoint behavior: returns page numbers in Link header
|
||||
responses = [
|
||||
# Pulls endpoint uses traditional 'page' parameter (not cursor)
|
||||
MockHTTPResponse(
|
||||
data=[{"pull": i} for i in range(1, 101)], # Page 1 contents
|
||||
link_header='<https://api.github.com/repos/owner/repo/pulls?per_page=100&page=2>; rel="next"',
|
||||
),
|
||||
MockHTTPResponse(
|
||||
data=[{"pull": i} for i in range(101, 181)], # Page 2 contents
|
||||
link_header=None, # No Link header - signals end of pagination
|
||||
),
|
||||
]
|
||||
requests_made = []
|
||||
|
||||
def mock_urlopen(request, *args, **kwargs):
|
||||
url = request.get_full_url()
|
||||
requests_made.append(url)
|
||||
return responses[len(requests_made) - 1]
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
results = github_backup.retrieve_data(
|
||||
mock_args, "https://api.github.com/repos/owner/repo/pulls"
|
||||
)
|
||||
|
||||
# Verify all items retrieved and page parameter was used (not cursor)
|
||||
assert len(results) == 180
|
||||
assert len(requests_made) == 2
|
||||
assert "page=2" in requests_made[1]
|
||||
assert "after" not in requests_made[1]
|
||||
|
||||
|
||||
def test_no_link_header_stops_pagination(mock_args):
|
||||
"""Pagination stops when Link header is absent."""
|
||||
|
||||
# Simulate endpoint with results that fit in a single page
|
||||
responses = [
|
||||
MockHTTPResponse(
|
||||
data=[{"label": i} for i in range(1, 51)], # Page contents
|
||||
link_header=None, # No Link header - signals end of pagination
|
||||
)
|
||||
]
|
||||
requests_made = []
|
||||
|
||||
def mock_urlopen(request, *args, **kwargs):
|
||||
requests_made.append(request.get_full_url())
|
||||
return responses[len(requests_made) - 1]
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
results = github_backup.retrieve_data(
|
||||
mock_args, "https://api.github.com/repos/owner/repo/labels"
|
||||
)
|
||||
|
||||
# Verify pagination stopped after first request
|
||||
assert len(results) == 50
|
||||
assert len(requests_made) == 1
|
||||
359
tests/test_retrieve_data.py
Normal file
359
tests/test_retrieve_data.py
Normal file
@@ -0,0 +1,359 @@
|
||||
"""Tests for retrieve_data function."""
|
||||
|
||||
import json
|
||||
import socket
|
||||
from unittest.mock import Mock, patch
|
||||
from urllib.error import HTTPError, URLError
|
||||
|
||||
import pytest
|
||||
|
||||
from github_backup import github_backup
|
||||
from github_backup.github_backup import (
|
||||
MAX_RETRIES,
|
||||
calculate_retry_delay,
|
||||
make_request_with_retry,
|
||||
)
|
||||
|
||||
|
||||
class TestCalculateRetryDelay:
|
||||
def test_respects_retry_after_header(self):
|
||||
headers = {'retry-after': '30'}
|
||||
assert calculate_retry_delay(0, headers) == 30
|
||||
|
||||
def test_respects_rate_limit_reset(self):
|
||||
import time
|
||||
import calendar
|
||||
# Set reset time 60 seconds in the future
|
||||
future_reset = calendar.timegm(time.gmtime()) + 60
|
||||
headers = {
|
||||
'x-ratelimit-remaining': '0',
|
||||
'x-ratelimit-reset': str(future_reset)
|
||||
}
|
||||
delay = calculate_retry_delay(0, headers)
|
||||
# Should be approximately 60 seconds (with some tolerance for execution time)
|
||||
assert 55 <= delay <= 65
|
||||
|
||||
def test_exponential_backoff(self):
|
||||
delay_0 = calculate_retry_delay(0, {})
|
||||
delay_1 = calculate_retry_delay(1, {})
|
||||
delay_2 = calculate_retry_delay(2, {})
|
||||
# Base delay is 1s, so delays should be roughly 1, 2, 4 (plus jitter)
|
||||
assert 0.9 <= delay_0 <= 1.2 # ~1s + up to 10% jitter
|
||||
assert 1.8 <= delay_1 <= 2.4 # ~2s + up to 10% jitter
|
||||
assert 3.6 <= delay_2 <= 4.8 # ~4s + up to 10% jitter
|
||||
|
||||
def test_max_delay_cap(self):
|
||||
# Very high attempt number should not exceed 120s + jitter
|
||||
delay = calculate_retry_delay(100, {})
|
||||
assert delay <= 120 * 1.1 # 120s max + 10% jitter
|
||||
|
||||
def test_minimum_rate_limit_delay(self):
|
||||
import time
|
||||
import calendar
|
||||
# Set reset time in the past (already reset)
|
||||
past_reset = calendar.timegm(time.gmtime()) - 100
|
||||
headers = {
|
||||
'x-ratelimit-remaining': '0',
|
||||
'x-ratelimit-reset': str(past_reset)
|
||||
}
|
||||
delay = calculate_retry_delay(0, headers)
|
||||
# Should be minimum 10 seconds even if reset time is in past
|
||||
assert delay >= 10
|
||||
|
||||
|
||||
class TestRetrieveDataRetry:
|
||||
"""Tests for retry behavior in retrieve_data."""
|
||||
|
||||
@pytest.fixture
|
||||
def mock_args(self):
|
||||
args = Mock()
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = "fake_token"
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.throttle_limit = None
|
||||
args.throttle_pause = 0
|
||||
return args
|
||||
|
||||
def test_json_parse_error_retries_and_fails(self, mock_args):
|
||||
"""HTTP 200 with invalid JSON should retry and eventually fail."""
|
||||
mock_response = Mock()
|
||||
mock_response.getcode.return_value = 200
|
||||
mock_response.read.return_value = b"not valid json {"
|
||||
mock_response.headers = {"x-ratelimit-remaining": "5000"}
|
||||
|
||||
call_count = 0
|
||||
|
||||
def mock_make_request(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
return mock_response
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", side_effect=mock_make_request):
|
||||
with patch("github_backup.github_backup.calculate_retry_delay", return_value=0): # No delay in tests
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/repo/issues")
|
||||
|
||||
assert "Failed to read response after" in str(exc_info.value)
|
||||
assert call_count == MAX_RETRIES
|
||||
|
||||
def test_json_parse_error_recovers_on_retry(self, mock_args):
|
||||
"""HTTP 200 with invalid JSON should succeed if retry returns valid JSON."""
|
||||
bad_response = Mock()
|
||||
bad_response.getcode.return_value = 200
|
||||
bad_response.read.return_value = b"not valid json {"
|
||||
bad_response.headers = {"x-ratelimit-remaining": "5000"}
|
||||
|
||||
good_response = Mock()
|
||||
good_response.getcode.return_value = 200
|
||||
good_response.read.return_value = json.dumps([{"id": 1}]).encode("utf-8")
|
||||
good_response.headers = {"x-ratelimit-remaining": "5000", "Link": ""}
|
||||
|
||||
responses = [bad_response, bad_response, good_response]
|
||||
call_count = 0
|
||||
|
||||
def mock_make_request(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
result = responses[call_count]
|
||||
call_count += 1
|
||||
return result
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", side_effect=mock_make_request):
|
||||
with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
|
||||
result = github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/repo/issues")
|
||||
|
||||
assert result == [{"id": 1}]
|
||||
assert call_count == 3 # Failed twice, succeeded on third
|
||||
|
||||
def test_http_error_raises_exception(self, mock_args):
|
||||
"""Non-success HTTP status codes should raise Exception."""
|
||||
mock_response = Mock()
|
||||
mock_response.getcode.return_value = 404
|
||||
mock_response.read.return_value = b'{"message": "Not Found"}'
|
||||
mock_response.headers = {"x-ratelimit-remaining": "5000"}
|
||||
mock_response.reason = "Not Found"
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/notfound/issues")
|
||||
|
||||
assert not isinstance(exc_info.value, github_backup.RepositoryUnavailableError)
|
||||
assert "404" in str(exc_info.value)
|
||||
|
||||
|
||||
class TestMakeRequestWithRetry:
|
||||
"""Tests for HTTP error retry behavior in make_request_with_retry."""
|
||||
|
||||
def test_502_error_retries_and_succeeds(self):
|
||||
"""HTTP 502 should retry and succeed if subsequent request works."""
|
||||
good_response = Mock()
|
||||
good_response.read.return_value = b'{"ok": true}'
|
||||
|
||||
call_count = 0
|
||||
fail_count = MAX_RETRIES - 1 # Fail all but last attempt
|
||||
|
||||
def mock_urlopen(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
if call_count <= fail_count:
|
||||
raise HTTPError(
|
||||
url="https://api.github.com/test",
|
||||
code=502,
|
||||
msg="Bad Gateway",
|
||||
hdrs={"x-ratelimit-remaining": "5000"},
|
||||
fp=None,
|
||||
)
|
||||
return good_response
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
|
||||
result = make_request_with_retry(Mock(), None)
|
||||
|
||||
assert result == good_response
|
||||
assert call_count == MAX_RETRIES
|
||||
|
||||
def test_503_error_retries_until_exhausted(self):
|
||||
"""HTTP 503 should retry MAX_RETRIES times then raise."""
|
||||
call_count = 0
|
||||
|
||||
def mock_urlopen(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
raise HTTPError(
|
||||
url="https://api.github.com/test",
|
||||
code=503,
|
||||
msg="Service Unavailable",
|
||||
hdrs={"x-ratelimit-remaining": "5000"},
|
||||
fp=None,
|
||||
)
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
|
||||
with pytest.raises(HTTPError) as exc_info:
|
||||
make_request_with_retry(Mock(), None)
|
||||
|
||||
assert exc_info.value.code == 503
|
||||
assert call_count == MAX_RETRIES
|
||||
|
||||
def test_404_error_not_retried(self):
|
||||
"""HTTP 404 should not be retried - raise immediately."""
|
||||
call_count = 0
|
||||
|
||||
def mock_urlopen(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
raise HTTPError(
|
||||
url="https://api.github.com/test",
|
||||
code=404,
|
||||
msg="Not Found",
|
||||
hdrs={"x-ratelimit-remaining": "5000"},
|
||||
fp=None,
|
||||
)
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
with pytest.raises(HTTPError) as exc_info:
|
||||
make_request_with_retry(Mock(), None)
|
||||
|
||||
assert exc_info.value.code == 404
|
||||
assert call_count == 1 # No retries
|
||||
|
||||
def test_rate_limit_403_retried_when_remaining_zero(self):
|
||||
"""HTTP 403 with x-ratelimit-remaining=0 should retry."""
|
||||
good_response = Mock()
|
||||
call_count = 0
|
||||
|
||||
def mock_urlopen(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
if call_count == 1:
|
||||
raise HTTPError(
|
||||
url="https://api.github.com/test",
|
||||
code=403,
|
||||
msg="Forbidden",
|
||||
hdrs={"x-ratelimit-remaining": "0"},
|
||||
fp=None,
|
||||
)
|
||||
return good_response
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
|
||||
result = make_request_with_retry(Mock(), None)
|
||||
|
||||
assert result == good_response
|
||||
assert call_count == 2
|
||||
|
||||
def test_403_not_retried_when_remaining_nonzero(self):
|
||||
"""HTTP 403 with x-ratelimit-remaining>0 should not retry (permission error)."""
|
||||
call_count = 0
|
||||
|
||||
def mock_urlopen(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
raise HTTPError(
|
||||
url="https://api.github.com/test",
|
||||
code=403,
|
||||
msg="Forbidden",
|
||||
hdrs={"x-ratelimit-remaining": "5000"},
|
||||
fp=None,
|
||||
)
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
with pytest.raises(HTTPError) as exc_info:
|
||||
make_request_with_retry(Mock(), None)
|
||||
|
||||
assert exc_info.value.code == 403
|
||||
assert call_count == 1 # No retries
|
||||
|
||||
def test_connection_error_retries_and_succeeds(self):
|
||||
"""URLError (connection error) should retry and succeed if subsequent request works."""
|
||||
good_response = Mock()
|
||||
call_count = 0
|
||||
fail_count = MAX_RETRIES - 1 # Fail all but last attempt
|
||||
|
||||
def mock_urlopen(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
if call_count <= fail_count:
|
||||
raise URLError("Connection refused")
|
||||
return good_response
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
|
||||
result = make_request_with_retry(Mock(), None)
|
||||
|
||||
assert result == good_response
|
||||
assert call_count == MAX_RETRIES
|
||||
|
||||
def test_socket_error_retries_until_exhausted(self):
|
||||
"""socket.error should retry MAX_RETRIES times then raise."""
|
||||
call_count = 0
|
||||
|
||||
def mock_urlopen(*args, **kwargs):
|
||||
nonlocal call_count
|
||||
call_count += 1
|
||||
raise socket.error("Connection reset by peer")
|
||||
|
||||
with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
|
||||
with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
|
||||
with pytest.raises(socket.error):
|
||||
make_request_with_retry(Mock(), None)
|
||||
|
||||
assert call_count == MAX_RETRIES
|
||||
|
||||
|
||||
class TestRetrieveDataThrottling:
|
||||
"""Tests for throttling behavior in retrieve_data."""
|
||||
|
||||
@pytest.fixture
|
||||
def mock_args(self):
|
||||
args = Mock()
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = "fake_token"
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.throttle_limit = 10 # Throttle when remaining <= 10
|
||||
args.throttle_pause = 5 # Pause 5 seconds
|
||||
return args
|
||||
|
||||
def test_throttling_pauses_when_rate_limit_low(self, mock_args):
|
||||
"""Should pause when x-ratelimit-remaining is at or below throttle_limit."""
|
||||
mock_response = Mock()
|
||||
mock_response.getcode.return_value = 200
|
||||
mock_response.read.return_value = json.dumps([{"id": 1}]).encode("utf-8")
|
||||
mock_response.headers = {"x-ratelimit-remaining": "5", "Link": ""} # Below throttle_limit
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
|
||||
with patch("github_backup.github_backup.time.sleep") as mock_sleep:
|
||||
github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/repo/issues")
|
||||
|
||||
mock_sleep.assert_called_once_with(5) # throttle_pause value
|
||||
|
||||
|
||||
class TestRetrieveDataSingleItem:
|
||||
"""Tests for single item (dict) responses in retrieve_data."""
|
||||
|
||||
@pytest.fixture
|
||||
def mock_args(self):
|
||||
args = Mock()
|
||||
args.as_app = False
|
||||
args.token_fine = None
|
||||
args.token_classic = "fake_token"
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.throttle_limit = None
|
||||
args.throttle_pause = 0
|
||||
return args
|
||||
|
||||
def test_dict_response_returned_as_list(self, mock_args):
|
||||
"""Single dict response should be returned as a list with one item."""
|
||||
mock_response = Mock()
|
||||
mock_response.getcode.return_value = 200
|
||||
mock_response.read.return_value = json.dumps({"login": "testuser", "id": 123}).encode("utf-8")
|
||||
mock_response.headers = {"x-ratelimit-remaining": "5000", "Link": ""}
|
||||
|
||||
with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
|
||||
result = github_backup.retrieve_data(mock_args, "https://api.github.com/user")
|
||||
|
||||
assert result == [{"login": "testuser", "id": 123}]
|
||||
318
tests/test_skip_assets_on.py
Normal file
318
tests/test_skip_assets_on.py
Normal file
@@ -0,0 +1,318 @@
|
||||
"""Tests for --skip-assets-on flag behavior (issue #135)."""
|
||||
|
||||
import pytest
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
from github_backup import github_backup
|
||||
|
||||
|
||||
class TestSkipAssetsOn:
|
||||
"""Test suite for --skip-assets-on flag.
|
||||
|
||||
Issue #135: Allow skipping asset downloads for specific repositories
|
||||
while still backing up release metadata.
|
||||
"""
|
||||
|
||||
def _create_mock_args(self, **overrides):
|
||||
"""Create a mock args object with sensible defaults."""
|
||||
args = Mock()
|
||||
args.user = "testuser"
|
||||
args.output_directory = "/tmp/backup"
|
||||
args.include_repository = False
|
||||
args.include_everything = False
|
||||
args.include_gists = False
|
||||
args.include_starred_gists = False
|
||||
args.all_starred = False
|
||||
args.skip_existing = False
|
||||
args.bare_clone = False
|
||||
args.lfs_clone = False
|
||||
args.no_prune = False
|
||||
args.include_wiki = False
|
||||
args.include_issues = False
|
||||
args.include_issue_comments = False
|
||||
args.include_issue_events = False
|
||||
args.include_pulls = False
|
||||
args.include_pull_comments = False
|
||||
args.include_pull_commits = False
|
||||
args.include_pull_details = False
|
||||
args.include_labels = False
|
||||
args.include_hooks = False
|
||||
args.include_milestones = False
|
||||
args.include_releases = True
|
||||
args.include_assets = True
|
||||
args.skip_assets_on = []
|
||||
args.include_attachments = False
|
||||
args.incremental = False
|
||||
args.incremental_by_files = False
|
||||
args.github_host = None
|
||||
args.prefer_ssh = False
|
||||
args.token_classic = "test-token"
|
||||
args.token_fine = None
|
||||
args.as_app = False
|
||||
args.osx_keychain_item_name = None
|
||||
args.osx_keychain_item_account = None
|
||||
args.skip_prerelease = False
|
||||
args.number_of_latest_releases = None
|
||||
|
||||
for key, value in overrides.items():
|
||||
setattr(args, key, value)
|
||||
|
||||
return args
|
||||
|
||||
def _create_mock_repository(self, name="test-repo", owner="testuser"):
|
||||
"""Create a mock repository object."""
|
||||
return {
|
||||
"name": name,
|
||||
"full_name": f"{owner}/{name}",
|
||||
"owner": {"login": owner},
|
||||
"private": False,
|
||||
"fork": False,
|
||||
"has_wiki": False,
|
||||
}
|
||||
|
||||
def _create_mock_release(self, tag="v1.0.0"):
|
||||
"""Create a mock release object."""
|
||||
return {
|
||||
"tag_name": tag,
|
||||
"name": tag,
|
||||
"prerelease": False,
|
||||
"draft": False,
|
||||
"assets_url": f"https://api.github.com/repos/testuser/test-repo/releases/{tag}/assets",
|
||||
}
|
||||
|
||||
def _create_mock_asset(self, name="asset.zip"):
|
||||
"""Create a mock asset object."""
|
||||
return {
|
||||
"name": name,
|
||||
"url": f"https://api.github.com/repos/testuser/test-repo/releases/assets/{name}",
|
||||
}
|
||||
|
||||
|
||||
class TestSkipAssetsOnArgumentParsing(TestSkipAssetsOn):
|
||||
"""Tests for --skip-assets-on argument parsing."""
|
||||
|
||||
def test_skip_assets_on_not_set_defaults_to_none(self):
|
||||
"""When --skip-assets-on is not specified, it should default to None."""
|
||||
args = github_backup.parse_args(["testuser"])
|
||||
assert args.skip_assets_on is None
|
||||
|
||||
def test_skip_assets_on_single_repo(self):
|
||||
"""Single --skip-assets-on should create list with one item."""
|
||||
args = github_backup.parse_args(["testuser", "--skip-assets-on", "big-repo"])
|
||||
assert args.skip_assets_on == ["big-repo"]
|
||||
|
||||
def test_skip_assets_on_multiple_repos(self):
|
||||
"""Multiple repos can be specified space-separated (like --exclude)."""
|
||||
args = github_backup.parse_args(
|
||||
[
|
||||
"testuser",
|
||||
"--skip-assets-on",
|
||||
"big-repo",
|
||||
"another-repo",
|
||||
"owner/third-repo",
|
||||
]
|
||||
)
|
||||
assert args.skip_assets_on == ["big-repo", "another-repo", "owner/third-repo"]
|
||||
|
||||
|
||||
class TestSkipAssetsOnBehavior(TestSkipAssetsOn):
|
||||
"""Tests for --skip-assets-on behavior in backup_releases."""
|
||||
|
||||
@patch("github_backup.github_backup.download_file")
|
||||
@patch("github_backup.github_backup.retrieve_data")
|
||||
@patch("github_backup.github_backup.mkdir_p")
|
||||
@patch("github_backup.github_backup.json_dump_if_changed")
|
||||
def test_assets_downloaded_when_not_skipped(
|
||||
self, mock_json_dump, mock_mkdir, mock_retrieve, mock_download
|
||||
):
|
||||
"""Assets should be downloaded when repo is not in skip list."""
|
||||
args = self._create_mock_args(skip_assets_on=[])
|
||||
repository = self._create_mock_repository(name="normal-repo")
|
||||
release = self._create_mock_release()
|
||||
asset = self._create_mock_asset()
|
||||
|
||||
mock_json_dump.return_value = True
|
||||
mock_retrieve.side_effect = [
|
||||
[release], # First call: get releases
|
||||
[asset], # Second call: get assets
|
||||
]
|
||||
|
||||
with patch("os.path.join", side_effect=lambda *args: "/".join(args)):
|
||||
github_backup.backup_releases(
|
||||
args,
|
||||
"/tmp/backup/repositories/normal-repo",
|
||||
repository,
|
||||
"https://api.github.com/repos/{owner}/{repo}",
|
||||
include_assets=True,
|
||||
)
|
||||
|
||||
# download_file should have been called for the asset
|
||||
mock_download.assert_called_once()
|
||||
|
||||
@patch("github_backup.github_backup.download_file")
|
||||
@patch("github_backup.github_backup.retrieve_data")
|
||||
@patch("github_backup.github_backup.mkdir_p")
|
||||
@patch("github_backup.github_backup.json_dump_if_changed")
|
||||
def test_assets_skipped_when_repo_name_matches(
|
||||
self, mock_json_dump, mock_mkdir, mock_retrieve, mock_download
|
||||
):
|
||||
"""Assets should be skipped when repo name is in skip list."""
|
||||
args = self._create_mock_args(skip_assets_on=["big-repo"])
|
||||
repository = self._create_mock_repository(name="big-repo")
|
||||
release = self._create_mock_release()
|
||||
|
||||
mock_json_dump.return_value = True
|
||||
mock_retrieve.return_value = [release]
|
||||
|
||||
github_backup.backup_releases(
|
||||
args,
|
||||
"/tmp/backup/repositories/big-repo",
|
||||
repository,
|
||||
"https://api.github.com/repos/{owner}/{repo}",
|
||||
include_assets=True,
|
||||
)
|
||||
|
||||
# download_file should NOT have been called
|
||||
mock_download.assert_not_called()
|
||||
|
||||
@patch("github_backup.github_backup.download_file")
|
||||
@patch("github_backup.github_backup.retrieve_data")
|
||||
@patch("github_backup.github_backup.mkdir_p")
|
||||
@patch("github_backup.github_backup.json_dump_if_changed")
|
||||
def test_assets_skipped_when_full_name_matches(
|
||||
self, mock_json_dump, mock_mkdir, mock_retrieve, mock_download
|
||||
):
|
||||
"""Assets should be skipped when owner/repo format matches."""
|
||||
args = self._create_mock_args(skip_assets_on=["otheruser/big-repo"])
|
||||
repository = self._create_mock_repository(name="big-repo", owner="otheruser")
|
||||
release = self._create_mock_release()
|
||||
|
||||
mock_json_dump.return_value = True
|
||||
mock_retrieve.return_value = [release]
|
||||
|
||||
github_backup.backup_releases(
|
||||
args,
|
||||
"/tmp/backup/repositories/big-repo",
|
||||
repository,
|
||||
"https://api.github.com/repos/{owner}/{repo}",
|
||||
include_assets=True,
|
||||
)
|
||||
|
||||
# download_file should NOT have been called
|
||||
mock_download.assert_not_called()
|
||||
|
||||
@patch("github_backup.github_backup.download_file")
|
||||
@patch("github_backup.github_backup.retrieve_data")
|
||||
@patch("github_backup.github_backup.mkdir_p")
|
||||
@patch("github_backup.github_backup.json_dump_if_changed")
|
||||
def test_case_insensitive_matching(
|
||||
self, mock_json_dump, mock_mkdir, mock_retrieve, mock_download
|
||||
):
|
||||
"""Skip matching should be case-insensitive."""
|
||||
# User types uppercase, repo name is lowercase
|
||||
args = self._create_mock_args(skip_assets_on=["BIG-REPO"])
|
||||
repository = self._create_mock_repository(name="big-repo")
|
||||
release = self._create_mock_release()
|
||||
|
||||
mock_json_dump.return_value = True
|
||||
mock_retrieve.return_value = [release]
|
||||
|
||||
github_backup.backup_releases(
|
||||
args,
|
||||
"/tmp/backup/repositories/big-repo",
|
||||
repository,
|
||||
"https://api.github.com/repos/{owner}/{repo}",
|
||||
include_assets=True,
|
||||
)
|
||||
|
||||
# download_file should NOT have been called (case-insensitive match)
|
||||
assert not mock_download.called
|
||||
|
||||
@patch("github_backup.github_backup.download_file")
|
||||
@patch("github_backup.github_backup.retrieve_data")
|
||||
@patch("github_backup.github_backup.mkdir_p")
|
||||
@patch("github_backup.github_backup.json_dump_if_changed")
|
||||
def test_multiple_skip_repos(
|
||||
self, mock_json_dump, mock_mkdir, mock_retrieve, mock_download
|
||||
):
|
||||
"""Multiple repos in skip list should all be skipped."""
|
||||
args = self._create_mock_args(skip_assets_on=["repo1", "repo2", "repo3"])
|
||||
repository = self._create_mock_repository(name="repo2")
|
||||
release = self._create_mock_release()
|
||||
|
||||
mock_json_dump.return_value = True
|
||||
mock_retrieve.return_value = [release]
|
||||
|
||||
github_backup.backup_releases(
|
||||
args,
|
||||
"/tmp/backup/repositories/repo2",
|
||||
repository,
|
||||
"https://api.github.com/repos/{owner}/{repo}",
|
||||
include_assets=True,
|
||||
)
|
||||
|
||||
# download_file should NOT have been called
|
||||
mock_download.assert_not_called()
|
||||
|
||||
@patch("github_backup.github_backup.download_file")
|
||||
@patch("github_backup.github_backup.retrieve_data")
|
||||
@patch("github_backup.github_backup.mkdir_p")
|
||||
@patch("github_backup.github_backup.json_dump_if_changed")
|
||||
def test_release_metadata_still_saved_when_assets_skipped(
|
||||
self, mock_json_dump, mock_mkdir, mock_retrieve, mock_download
|
||||
):
|
||||
"""Release JSON should still be saved even when assets are skipped."""
|
||||
args = self._create_mock_args(skip_assets_on=["big-repo"])
|
||||
repository = self._create_mock_repository(name="big-repo")
|
||||
release = self._create_mock_release()
|
||||
|
||||
mock_json_dump.return_value = True
|
||||
mock_retrieve.return_value = [release]
|
||||
|
||||
github_backup.backup_releases(
|
||||
args,
|
||||
"/tmp/backup/repositories/big-repo",
|
||||
repository,
|
||||
"https://api.github.com/repos/{owner}/{repo}",
|
||||
include_assets=True,
|
||||
)
|
||||
|
||||
# json_dump_if_changed should have been called for release metadata
|
||||
mock_json_dump.assert_called_once()
|
||||
# But download_file should NOT have been called
|
||||
mock_download.assert_not_called()
|
||||
|
||||
@patch("github_backup.github_backup.download_file")
|
||||
@patch("github_backup.github_backup.retrieve_data")
|
||||
@patch("github_backup.github_backup.mkdir_p")
|
||||
@patch("github_backup.github_backup.json_dump_if_changed")
|
||||
def test_non_matching_repo_still_downloads_assets(
|
||||
self, mock_json_dump, mock_mkdir, mock_retrieve, mock_download
|
||||
):
|
||||
"""Repos not in skip list should still download assets."""
|
||||
args = self._create_mock_args(skip_assets_on=["other-repo"])
|
||||
repository = self._create_mock_repository(name="normal-repo")
|
||||
release = self._create_mock_release()
|
||||
asset = self._create_mock_asset()
|
||||
|
||||
mock_json_dump.return_value = True
|
||||
mock_retrieve.side_effect = [
|
||||
[release], # First call: get releases
|
||||
[asset], # Second call: get assets
|
||||
]
|
||||
|
||||
with patch("os.path.join", side_effect=lambda *args: "/".join(args)):
|
||||
github_backup.backup_releases(
|
||||
args,
|
||||
"/tmp/backup/repositories/normal-repo",
|
||||
repository,
|
||||
"https://api.github.com/repos/{owner}/{repo}",
|
||||
include_assets=True,
|
||||
)
|
||||
|
||||
# download_file SHOULD have been called
|
||||
mock_download.assert_called_once()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
pytest.main([__file__, "-v"])
|
||||
224
tests/test_starred_skip_size_over.py
Normal file
224
tests/test_starred_skip_size_over.py
Normal file
@@ -0,0 +1,224 @@
|
||||
"""Tests for --starred-skip-size-over flag behavior (issue #108)."""
|
||||
|
||||
import pytest
|
||||
from unittest.mock import Mock
|
||||
|
||||
from github_backup import github_backup
|
||||
|
||||
|
||||
class TestStarredSkipSizeOver:
|
||||
"""Test suite for --starred-skip-size-over flag.
|
||||
|
||||
Issue #108: Allow restricting size of starred repositories before cloning.
|
||||
The size is based on the GitHub API's 'size' field (in KB), but the CLI
|
||||
argument accepts MB for user convenience.
|
||||
"""
|
||||
|
||||
def _create_mock_args(self, **overrides):
|
||||
"""Create a mock args object with sensible defaults."""
|
||||
args = Mock()
|
||||
args.user = "testuser"
|
||||
args.repository = None
|
||||
args.name_regex = None
|
||||
args.languages = None
|
||||
args.fork = False
|
||||
args.private = False
|
||||
args.skip_archived = False
|
||||
args.starred_skip_size_over = None
|
||||
args.exclude = None
|
||||
|
||||
for key, value in overrides.items():
|
||||
setattr(args, key, value)
|
||||
|
||||
return args
|
||||
|
||||
|
||||
class TestStarredSkipSizeOverArgumentParsing(TestStarredSkipSizeOver):
|
||||
"""Tests for --starred-skip-size-over argument parsing."""
|
||||
|
||||
def test_starred_skip_size_over_not_set_defaults_to_none(self):
|
||||
"""When --starred-skip-size-over is not specified, it should default to None."""
|
||||
args = github_backup.parse_args(["testuser"])
|
||||
assert args.starred_skip_size_over is None
|
||||
|
||||
def test_starred_skip_size_over_accepts_integer(self):
|
||||
"""--starred-skip-size-over should accept an integer value."""
|
||||
args = github_backup.parse_args(["testuser", "--starred-skip-size-over", "500"])
|
||||
assert args.starred_skip_size_over == 500
|
||||
|
||||
def test_starred_skip_size_over_rejects_non_integer(self):
|
||||
"""--starred-skip-size-over should reject non-integer values."""
|
||||
with pytest.raises(SystemExit):
|
||||
github_backup.parse_args(["testuser", "--starred-skip-size-over", "abc"])
|
||||
|
||||
|
||||
class TestStarredSkipSizeOverFiltering(TestStarredSkipSizeOver):
|
||||
"""Tests for --starred-skip-size-over filtering behavior."""
|
||||
|
||||
def test_starred_repo_under_limit_is_kept(self):
|
||||
"""Starred repos under the size limit should be kept."""
|
||||
args = self._create_mock_args(starred_skip_size_over=500)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "small-repo",
|
||||
"owner": {"login": "otheruser"},
|
||||
"size": 100 * 1024, # 100 MB in KB
|
||||
"is_starred": True,
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 1
|
||||
assert result[0]["name"] == "small-repo"
|
||||
|
||||
def test_starred_repo_over_limit_is_filtered(self):
|
||||
"""Starred repos over the size limit should be filtered out."""
|
||||
args = self._create_mock_args(starred_skip_size_over=500)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "huge-repo",
|
||||
"owner": {"login": "otheruser"},
|
||||
"size": 600 * 1024, # 600 MB in KB
|
||||
"is_starred": True,
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 0
|
||||
|
||||
def test_own_repo_over_limit_is_kept(self):
|
||||
"""User's own repos should not be affected by the size limit."""
|
||||
args = self._create_mock_args(starred_skip_size_over=500)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "my-huge-repo",
|
||||
"owner": {"login": "testuser"},
|
||||
"size": 600 * 1024, # 600 MB in KB
|
||||
# No is_starred flag - this is the user's own repo
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 1
|
||||
assert result[0]["name"] == "my-huge-repo"
|
||||
|
||||
def test_starred_repo_at_exact_limit_is_kept(self):
|
||||
"""Starred repos at exactly the size limit should be kept."""
|
||||
args = self._create_mock_args(starred_skip_size_over=500)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "exact-limit-repo",
|
||||
"owner": {"login": "otheruser"},
|
||||
"size": 500 * 1024, # Exactly 500 MB in KB
|
||||
"is_starred": True,
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 1
|
||||
assert result[0]["name"] == "exact-limit-repo"
|
||||
|
||||
def test_mixed_repos_filtered_correctly(self):
|
||||
"""Mix of own and starred repos should be filtered correctly."""
|
||||
args = self._create_mock_args(starred_skip_size_over=500)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "my-huge-repo",
|
||||
"owner": {"login": "testuser"},
|
||||
"size": 1000 * 1024, # 1 GB - own repo, should be kept
|
||||
},
|
||||
{
|
||||
"name": "starred-small",
|
||||
"owner": {"login": "otheruser"},
|
||||
"size": 100 * 1024, # 100 MB - under limit
|
||||
"is_starred": True,
|
||||
},
|
||||
{
|
||||
"name": "starred-huge",
|
||||
"owner": {"login": "anotheruser"},
|
||||
"size": 2000 * 1024, # 2 GB - over limit
|
||||
"is_starred": True,
|
||||
},
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 2
|
||||
names = [r["name"] for r in result]
|
||||
assert "my-huge-repo" in names
|
||||
assert "starred-small" in names
|
||||
assert "starred-huge" not in names
|
||||
|
||||
def test_no_size_limit_keeps_all_starred(self):
|
||||
"""When no size limit is set, all starred repos should be kept."""
|
||||
args = self._create_mock_args(starred_skip_size_over=None)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "huge-starred-repo",
|
||||
"owner": {"login": "otheruser"},
|
||||
"size": 10000 * 1024, # 10 GB
|
||||
"is_starred": True,
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 1
|
||||
|
||||
def test_repo_without_size_field_is_kept(self):
|
||||
"""Repos without a size field should be kept (size defaults to 0)."""
|
||||
args = self._create_mock_args(starred_skip_size_over=500)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "no-size-repo",
|
||||
"owner": {"login": "otheruser"},
|
||||
"is_starred": True,
|
||||
# No size field
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 1
|
||||
|
||||
def test_zero_value_warns_and_is_ignored(self, caplog):
|
||||
"""Zero value should warn and keep all repos."""
|
||||
args = self._create_mock_args(starred_skip_size_over=0)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "huge-starred-repo",
|
||||
"owner": {"login": "otheruser"},
|
||||
"size": 10000 * 1024, # 10 GB
|
||||
"is_starred": True,
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 1
|
||||
assert "must be greater than 0" in caplog.text
|
||||
|
||||
def test_negative_value_warns_and_is_ignored(self, caplog):
|
||||
"""Negative value should warn and keep all repos."""
|
||||
args = self._create_mock_args(starred_skip_size_over=-5)
|
||||
|
||||
repos = [
|
||||
{
|
||||
"name": "huge-starred-repo",
|
||||
"owner": {"login": "otheruser"},
|
||||
"size": 10000 * 1024, # 10 GB
|
||||
"is_starred": True,
|
||||
}
|
||||
]
|
||||
|
||||
result = github_backup.filter_repositories(args, repos)
|
||||
assert len(result) == 1
|
||||
assert "must be greater than 0" in caplog.text
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
pytest.main([__file__, "-v"])
|
||||
Reference in New Issue
Block a user