diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index cdaaf54d2..899f8fabf 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,11 +22,11 @@ jobs: sphinx: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 - name: Set up Python - uses: actions/setup-python@v5.4.0 + uses: actions/setup-python@v6.2.0 with: - python-version: "3.13" + python-version: "3.14" - name: Install dependencies run: pip install tox - name: Build docs @@ -37,11 +37,11 @@ jobs: twine-check: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 - name: Set up Python - uses: actions/setup-python@v5.4.0 + uses: actions/setup-python@v6.2.0 with: - python-version: "3.13" + python-version: "3.14" - name: Install dependencies run: pip install tox twine wheel - name: Check twine readme rendering diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 91217c6be..7a0dd38dc 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -22,12 +22,12 @@ jobs: lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 with: fetch-depth: 0 - - uses: actions/setup-python@v5.4.0 + - uses: actions/setup-python@v6.2.0 with: - python-version: "3.12" + python-version: "3.14" - run: pip install --upgrade tox - name: Run commitizen (https://commitizen-tools.github.io/commitizen/) run: tox -e cz diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml index 05e21065c..f6f1c6229 100644 --- a/.github/workflows/lock.yml +++ b/.github/workflows/lock.yml @@ -15,6 +15,6 @@ jobs: action: runs-on: ubuntu-latest steps: - - uses: dessant/lock-threads@v5.0.1 + - uses: dessant/lock-threads@v6.0.0 with: process-only: 'issues' diff --git a/.github/workflows/pre_commit.yml b/.github/workflows/pre_commit.yml index 44e71adfd..993606750 100644 --- a/.github/workflows/pre_commit.yml +++ b/.github/workflows/pre_commit.yml @@ -29,10 +29,10 @@ jobs: pre_commit: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.2 - - uses: actions/setup-python@v5.4.0 + - uses: actions/checkout@v6.0.2 + - uses: actions/setup-python@v6.2.0 with: - python-version: "3.11" + python-version: "3.14" - name: install tox run: pip install tox==3.26.0 - name: pre-commit diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a9be4bea8..01829b244 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -14,14 +14,14 @@ jobs: id-token: write environment: pypi.org steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 with: fetch-depth: 0 token: ${{ secrets.RELEASE_GITHUB_TOKEN }} - name: Python Semantic Release id: release - uses: python-semantic-release/python-semantic-release@v9.17.0 + uses: python-semantic-release/python-semantic-release@v10.5.3 with: github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }} @@ -32,7 +32,7 @@ jobs: if: steps.release.outputs.released == 'true' - name: Publish package distributions to GitHub Releases - uses: python-semantic-release/upload-to-gh-release@0a92b5d7ebfc15a84f9801ebd1bf706343d43711 # v9.8.9 + uses: python-semantic-release/publish-action@v10.5.3 if: steps.release.outputs.released == 'true' with: - github_token: ${{ secrets.GITHUB_TOKEN }} + github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }} diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index cdfaee27b..167deac9b 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -3,10 +3,12 @@ name: 'Close stale issues and PRs' on: schedule: - cron: '30 1 * * *' + workflow_dispatch: # For manual runs permissions: issues: write pull-requests: write + actions: write concurrency: group: lock @@ -15,21 +17,66 @@ jobs: stale: runs-on: ubuntu-latest steps: - - uses: actions/stale@v9.1.0 + - uses: actions/stale@v10.2.0 with: + operations-per-run: 500 stale-issue-label: "stale" stale-pr-label: "stale" - any-of-labels: 'need info,Waiting for response,stale' - stale-issue-message: > - This issue was marked stale because it has been open 60 days with no - activity. Please remove the stale label or comment on this issue. Otherwise, - it will be closed in 15 days. + # If an issue/PR has an assignee it won't be marked as stale + exempt-all-assignees: true + stale-issue-message: | + This issue was marked stale because it has been open 60 days with + no activity. Please remove the stale label or comment on this + issue. Otherwise, it will be closed in 15 days. + + As an open-source project, we rely on community contributions to + address many of the reported issues. Without a proposed fix or + active work towards a solution it is our policy to close inactive + issues. This is documented in CONTRIBUTING.rst + + **How to keep this issue open:** + * If you are still experiencing this issue and are willing to + investigate a fix, please comment and let us know. + * If you (or someone else) can propose a pull request with a + solution, that would be fantastic. + * Any significant update or active discussion indicating progress + will also prevent closure. + + We value your input. If you can help provide a fix, we'd be happy + to keep this issue open and support your efforts. + + This is documented in CONTRIBUTING.rst + https://github.com/python-gitlab/python-gitlab/blob/main/CONTRIBUTING.rst + days-before-issue-stale: 60 days-before-issue-close: 15 - close-issue-message: > - This issue was closed because it has been marked stale for 15 days with no - activity. If this issue is still valid, please re-open. + close-issue-message: | + This issue was closed because it has been marked stale for 15 days + with no activity. + + This open-source project relies on community contributions, and + while we value all feedback, we have a limited capacity to address + every issue without a clear path forward. + + Currently, this issue hasn't received a proposed fix, and there + hasn't been recent active discussion indicating someone is planning + to work on it. To maintain a manageable backlog and focus our + efforts, we will be closing this issue for now. + + **This doesn't mean the issue isn't valid or important.** If you or + anyone else in the community is willing to investigate and propose + a solution (e.g., by submitting a pull request), please do. + + We believe that those who feel a bug is important enough to fix + should ideally be part of the solution. Your contributions are + highly welcome. + + Thank you for your understanding and potential future + contributions. + + This is documented in CONTRIBUTING.rst + https://github.com/python-gitlab/python-gitlab/blob/main/CONTRIBUTING.rst stale-pr-message: > This Pull Request (PR) was marked stale because it has been open 90 days @@ -40,4 +87,3 @@ jobs: close-pr-message: > This PR was closed because it has been marked stale for 15 days with no activity. If this PR is still valid, please re-open. - diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 04d533f54..125555594 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -26,8 +26,6 @@ jobs: matrix: os: [ubuntu-latest] python: - - version: "3.9" - toxenv: py39,smoke - version: "3.10" toxenv: py310,smoke - version: "3.11" @@ -36,21 +34,21 @@ jobs: toxenv: py312,smoke - version: "3.13" toxenv: py313,smoke - - version: "3.14.0-alpha - 3.14" # SemVer's version range syntax + - version: "3.14" toxenv: py314,smoke include: - os: macos-latest python: - version: "3.13" - toxenv: py313,smoke + version: "3.14" + toxenv: py314,smoke - os: windows-latest python: - version: "3.13" - toxenv: py313,smoke + version: "3.14" + toxenv: py314,smoke steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 - name: Set up Python ${{ matrix.python.version }} - uses: actions/setup-python@v5.4.0 + uses: actions/setup-python@v6.2.0 with: python-version: ${{ matrix.python.version }} - name: Install dependencies @@ -67,11 +65,11 @@ jobs: matrix: toxenv: [api_func_v4, cli_func_v4] steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 - name: Set up Python - uses: actions/setup-python@v5.4.0 + uses: actions/setup-python@v6.2.0 with: - python-version: "3.12" + python-version: "3.14" - name: Install dependencies run: pip install tox - name: Run tests @@ -79,7 +77,7 @@ jobs: TOXENV: ${{ matrix.toxenv }} run: tox -- --override-ini='log_cli=True' - name: Upload codecov coverage - uses: codecov/codecov-action@v5.3.1 + uses: codecov/codecov-action@v6.0.0 with: files: ./coverage.xml flags: ${{ matrix.toxenv }} @@ -89,11 +87,11 @@ jobs: coverage: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5.4.0 + uses: actions/setup-python@v6.2.0 with: - python-version: "3.12" + python-version: "3.14" - name: Install dependencies run: pip install tox - name: Run tests @@ -102,7 +100,7 @@ jobs: TOXENV: cover run: tox - name: Upload codecov coverage - uses: codecov/codecov-action@v5.3.1 + uses: codecov/codecov-action@v6.0.0 with: files: ./coverage.xml flags: unit @@ -113,16 +111,16 @@ jobs: runs-on: ubuntu-latest name: Python wheel steps: - - uses: actions/checkout@v4.2.2 - - uses: actions/setup-python@v5.4.0 + - uses: actions/checkout@v6.0.2 + - uses: actions/setup-python@v6.2.0 with: - python-version: "3.12" + python-version: "3.14" - name: Install dependencies run: | pip install -r requirements-test.txt - name: Build package run: python -m build -o dist/ - - uses: actions/upload-artifact@v4.6.0 + - uses: actions/upload-artifact@v7.0.1 with: name: dist path: dist @@ -131,12 +129,12 @@ jobs: runs-on: ubuntu-latest needs: [dist] steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v6.0.2 - name: Set up Python - uses: actions/setup-python@v5.4.0 + uses: actions/setup-python@v6.2.0 with: - python-version: '3.12' - - uses: actions/download-artifact@v4.1.8 + python-version: '3.14' + - uses: actions/download-artifact@v8.0.1 with: name: dist path: dist diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b1094aa9a..8a396443b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,4 +1,4 @@ -image: python:3.13 +image: python:3.14 stages: - build diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 07a24684f..3e428a173 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,41 +3,41 @@ default_language_version: repos: - repo: https://github.com/psf/black - rev: 25.1.0 + rev: 26.3.1 hooks: - id: black - repo: https://github.com/commitizen-tools/commitizen - rev: v4.1.1 + rev: v4.13.10 hooks: - id: commitizen stages: [commit-msg] - repo: https://github.com/pycqa/flake8 - rev: 7.1.1 + rev: 7.3.0 hooks: - id: flake8 - repo: https://github.com/pycqa/isort - rev: 5.13.2 + rev: 8.0.1 hooks: - id: isort - repo: https://github.com/pycqa/pylint - rev: v3.3.4 + rev: v4.0.5 hooks: - id: pylint additional_dependencies: - argcomplete==2.0.0 - - gql==3.5.0 + - gql==4.0.0 - httpx==0.27.2 - pytest==7.4.2 - requests==2.28.1 - requests-toolbelt==1.0.0 files: 'gitlab/' - repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.14.1 + rev: v1.20.0 hooks: - id: mypy args: [] additional_dependencies: - - gql==3.5.0 + - gql==4.0.0 - httpx==0.27.2 - jinja2==3.1.2 - pytest==7.4.2 @@ -51,6 +51,6 @@ repos: - id: rst-directive-colons - id: rst-inline-touching-normal - repo: https://github.com/maxbrunet/pre-commit-renovate - rev: 39.156.1 + rev: 43.111.0 hooks: - id: renovate-config-validator diff --git a/.readthedocs.yml b/.readthedocs.yml index 2d561b88b..facdbd3f9 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,7 +3,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.11" + python: "3.13" sphinx: configuration: docs/conf.py diff --git a/CHANGELOG.md b/CHANGELOG.md index c4cf99cd4..7692c338c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,288 @@ # CHANGELOG +All versions below are listed in reverse chronological order. + +## v8.2.0 (2026-03-28) + +### Documentation + +- **testing**: Document passing pytest options during local development + ([`e6669f9`](https://github.com/python-gitlab/python-gitlab/commit/e6669f96d662d310109afa4a61fe8dabbd780a4e)) + +### Features + +- **api**: Add support for project feature flags and feature flag user lists + ([`be68285`](https://github.com/python-gitlab/python-gitlab/commit/be68285793f35afc10a72b59da3fb24429631f54)) + +- **projects**: Add optional parameter to set approval rule on all protected branches. + ([`8d76028`](https://github.com/python-gitlab/python-gitlab/commit/8d76028a1ae3554527291dc98e6be041ff089ec5)) + + +## v8.1.0 (2026-02-28) + +### Bug Fixes + +- **types**: Add explicit submodule import for pyright compatibility + ([`84ad3fd`](https://github.com/python-gitlab/python-gitlab/commit/84ad3fd19cfbc236e962ac77c910571b0888c000)) + +### Features + +- **api**: Add support for order_by filter in runner jobs + ([`d5dc73d`](https://github.com/python-gitlab/python-gitlab/commit/d5dc73d0f82a15d96a956c1d868c253c9586e1bf)) + +- **api**: Add support for sort filter in runner jobs + ([`b117ee3`](https://github.com/python-gitlab/python-gitlab/commit/b117ee3d139f422e463ebeb5007517a2052af8a4)) + + +## v8.0.0 (2026-01-28) + +### Bug Fixes + +- Actually define project repr_attr + ([`4187a69`](https://github.com/python-gitlab/python-gitlab/commit/4187a69420dd7b2e60c2d833ab246aec745d35cb)) + +- File save start_branch as a body attribute + ([`1001d93`](https://github.com/python-gitlab/python-gitlab/commit/1001d934e8c36cc3b14408b46b41030bf705a294)) + +### Chores + +- **black**: Run black v26 on code + ([`4a8d82b`](https://github.com/python-gitlab/python-gitlab/commit/4a8d82bec8f09fa142e8134589a0f40ef4f9c3be)) + +- **precommit**: Update dependency black to v26 + ([`ad43b76`](https://github.com/python-gitlab/python-gitlab/commit/ad43b763acdcd8d7db832972921fb071ea0a826f)) + +### Features + +- **graphql**: Update to gql 4.0.0 + ([`6f0da67`](https://github.com/python-gitlab/python-gitlab/commit/6f0da671b4586b23232ae89d57622254fa8a7945)) + +### Breaking Changes + +- **graphql**: GraphQL.execute() no longer accepts graphql.Source + + +## v7.1.0 (2025-12-28) + +### Bug Fixes + +- **utils**: Prevent negative sleep time in rate limit retry + ([`4221195`](https://github.com/python-gitlab/python-gitlab/commit/422119576287de30e1b70411c7ab0bbe39231af7)) + +### Continuous Integration + +- **release**: Use the correct token for publish to GitHub + ([`614a74c`](https://github.com/python-gitlab/python-gitlab/commit/614a74c00f027f70b8e48a6b2a2ddcd3f823bffa)) + +### Features + +- **registry-protection**: Add support for registry protection rule deletion + ([`9dd62c3`](https://github.com/python-gitlab/python-gitlab/commit/9dd62c3f5bcf3e082c2733bd4edc068f993c22ec)) + +### Testing + +- **functional**: Update to GitLab 18.6 and resolve issues found + ([`c7c139b`](https://github.com/python-gitlab/python-gitlab/commit/c7c139b9e7823ec1800a819233aee469355ee8d1)) + + +## v7.0.0 (2025-10-29) + +### Features + +- Drop Python 3.9 support and add Python 3.14 + ([`22941ac`](https://github.com/python-gitlab/python-gitlab/commit/22941acc3f331d5b683599c014ec962ece5d4b76)) + +### Breaking Changes + +- As of python-gitlab 7.0.0, Python 3.9 is no longer supported. Python 3.10 or higher is required. + + +## v6.5.0 (2025-10-17) + +### Bug Fixes + +- **semantic-release**: Enable CHANGELOG.md generation + ([`fb9693b`](https://github.com/python-gitlab/python-gitlab/commit/fb9693bf1e6798149196e57fed87bf2588ad3b47)) + +### Continuous Integration + +- **stale**: Fix permission for stale action and allow manual run + ([`9357a37`](https://github.com/python-gitlab/python-gitlab/commit/9357a374702dcc8049a6d8af636f48c736d3f160)) + +### Documentation + +- **pull_mirror**: Fix incorrect start() method usage example + ([`2acac19`](https://github.com/python-gitlab/python-gitlab/commit/2acac19356c8624def90c7e54237b256bceece18)) + +### Features + +- **api**: Add content_ref and dry_run_ref parameters to ProjectCiLintManager + ([`e8d2538`](https://github.com/python-gitlab/python-gitlab/commit/e8d2538cdf85a7c57babbc00074efbdab97548cd)) + +- **users**: Implement 'skip_confirmation' in users 'emails' creation + ([`2981730`](https://github.com/python-gitlab/python-gitlab/commit/298173017be387f26aa0828cae1e9a48e3cce328)) + + +## v6.4.0 (2025-09-28) + +### Features + +- **users**: Implement missing arguments in users 'list' + ([`99923d4`](https://github.com/python-gitlab/python-gitlab/commit/99923d40dcb4f32f02bcbc5e8ef5ec4b77e3cb02)) + +- **users**: Sort 'user list' arguments against documentation + ([`99923d4`](https://github.com/python-gitlab/python-gitlab/commit/99923d40dcb4f32f02bcbc5e8ef5ec4b77e3cb02)) + + +## v6.3.0 (2025-08-28) + +### Features + +- Add sync method to force remote mirror updates + ([`f3c6678`](https://github.com/python-gitlab/python-gitlab/commit/f3c6678482b7ca35b1dd1e3bc49fc0c56cd03639)) + +- **api**: Add missing ProjectJob list filters + ([`5fe0e71`](https://github.com/python-gitlab/python-gitlab/commit/5fe0e715448b00a666f76cdce6db321686f6a271)) + +- **api**: Add missing ProjectPackageManager list filters + ([`b1696be`](https://github.com/python-gitlab/python-gitlab/commit/b1696be5fb223028755e303069e23e42a11cab42)) + +- **users**: Implement support for 'admins' in administrators 'list' + ([`aaed51c`](https://github.com/python-gitlab/python-gitlab/commit/aaed51cdec65c8acabe8b9a39fd18c7e1e48519c)) + + +## v6.2.0 (2025-07-28) + +### Build System + +- **release**: Use correct python-semantic-release/publish-action + ([`2f20634`](https://github.com/python-gitlab/python-gitlab/commit/2f20634b9700bc802177278ffdd7bdf83ef1605a)) + +### Continuous Integration + +- **stale**: Improve formatting of stale message + ([`0ef20d1`](https://github.com/python-gitlab/python-gitlab/commit/0ef20d1b0ee6cd82c4e34003aca4c0c72935f4d9)) + +- **stale**: Increase `operations-per-run` to 500 + ([`326e1a4`](https://github.com/python-gitlab/python-gitlab/commit/326e1a46881467f41dc3de5f060ac654924fbe40)) + +### Features + +- **api**: Add ListMixin to ProjectIssueDiscussionNoteManager + ([`f908f0e`](https://github.com/python-gitlab/python-gitlab/commit/f908f0e82840a5df374e8fbfb1298608d23f02bd)) + +- **api**: Add ListMixin to ProjectMergeRequestDiscussionNoteManager + ([`865339a`](https://github.com/python-gitlab/python-gitlab/commit/865339ac037fb125280180b05a2c4e44067dc5e9)) + + +## v6.1.0 (2025-06-28) + +### Chores + +- Update to mypy 1.16.0 and resolve issues found + ([`f734c58`](https://github.com/python-gitlab/python-gitlab/commit/f734c586e3fe5a0e866bcf60030107ca142fa763)) + +### Documentation + +- Update CONTRIBUTING.rst with policy on issue management + ([`45dda50`](https://github.com/python-gitlab/python-gitlab/commit/45dda50ff4c0e01307480befa86498600563f818)) + +### Features + +- **api**: Add listing user contributed projects + ([`98c1307`](https://github.com/python-gitlab/python-gitlab/commit/98c13074127ae46d85545498746d55c8b75aef48)) + +- **api**: Add support for project tag list filters + ([`378a836`](https://github.com/python-gitlab/python-gitlab/commit/378a836bf5744ca6c9409dd60899e5d2f90b55be)) + +- **api**: Pipeline inputs support + ([#3194](https://github.com/python-gitlab/python-gitlab/pull/3194), + [`306c4b1`](https://github.com/python-gitlab/python-gitlab/commit/306c4b1931e2b03d7cbcef5773668e876d5644b1)) + +- **const**: Add PLANNER_ACCESS constant + ([`ba6f174`](https://github.com/python-gitlab/python-gitlab/commit/ba6f174896f908ba711e1e3e8ebf4692c86bd3d4)) + +- **groups**: Add protectedbranches to group class + ([#3164](https://github.com/python-gitlab/python-gitlab/pull/3164), + [`bfd31a8`](https://github.com/python-gitlab/python-gitlab/commit/bfd31a867547dffb2c2d54127e184fefa058cb30)) + + +## v6.0.0 (2025-06-04) + +### Chores + +- Add reformat code commit to .git-blame-ignore-revs + ([`a6ac939`](https://github.com/python-gitlab/python-gitlab/commit/a6ac9392b0e543df32adf9058f9808d199149982)) + +- Reformat code with skip_magic_trailing_comma = true + ([`2100aa4`](https://github.com/python-gitlab/python-gitlab/commit/2100aa458ba4f1c084bc97b00f7ba1693541d68a)) + +- Remove trivial get methods in preparation for generic Get mixin + ([`edd01a5`](https://github.com/python-gitlab/python-gitlab/commit/edd01a57aa8c45e6514e618263003beaa0fb68e8)) + +- Upgrade to sphinx 8.2.1 and resolve issues + ([`d0b5ae3`](https://github.com/python-gitlab/python-gitlab/commit/d0b5ae36bd0bc06f1f338adbd93d76a83a0fa459)) + +- **ci**: Replace docs artifact with readthedocs previews + ([`193c5de`](https://github.com/python-gitlab/python-gitlab/commit/193c5de9b443193da3f87d664a777f056d920146)) + +### Documentation + +- Use get_all keyword arg instead of all in docstrings + ([`f62dda7`](https://github.com/python-gitlab/python-gitlab/commit/f62dda7fa44e3bc46f03bd6402eba3f641f365eb)) + +- Use list(get_all=True) in documentation examples + ([`f36614f`](https://github.com/python-gitlab/python-gitlab/commit/f36614f1ce5a873ed1bbb8618ced39fa80f13ee6)) + +- **api-usage**: Fix GitLab API links to the publicly accessible URLs + ([`f55fa15`](https://github.com/python-gitlab/python-gitlab/commit/f55fa152cdccc0dd4815f17df9ff80628115667d)) + +- **api-usage-graphql**: Fix the example graphql query string + ([`8dbdd7e`](https://github.com/python-gitlab/python-gitlab/commit/8dbdd7e75447d01a457ac55f18066ebd355e4dbf)) + +- **job_token_scope**: Fix typo/inconsistency + ([`203bd92`](https://github.com/python-gitlab/python-gitlab/commit/203bd92e524845a3e1287439d78c167133347a69)) + +### Features + +- Adds member role methods + ([`055557e`](https://github.com/python-gitlab/python-gitlab/commit/055557efe9de9d4ab7b8237f7de7e033a6b02cd9)) + +- **api**: Add iteration_id as boards create attribute + ([#3191](https://github.com/python-gitlab/python-gitlab/pull/3191), + [`938b0d9`](https://github.com/python-gitlab/python-gitlab/commit/938b0d9c188bcffc6759184325bf292131307556)) + +- **api**: Add support for adding instance deploy keys + ([`22be96c`](https://github.com/python-gitlab/python-gitlab/commit/22be96cbe698f5d8b18be388edf9b01d6008d1dd)) + +- **api**: Add support for avatar removal + ([`5edd2e6`](https://github.com/python-gitlab/python-gitlab/commit/5edd2e66cd5d4cd48fcf5f996d4ad4c3d495b3fa)) + +- **api**: Add support for token self-rotation + ([`da40e09`](https://github.com/python-gitlab/python-gitlab/commit/da40e09498277467878b810aa44f86b48813d832)) + +- **api**: ListMixin.list typing overload + ([`6eee494`](https://github.com/python-gitlab/python-gitlab/commit/6eee494749ccc5387a0d3af7ce331cfb1e95308b)) + +- **api**: Make RESTManager generic on RESTObject class + ([`91c4f18`](https://github.com/python-gitlab/python-gitlab/commit/91c4f18dc49a7eed101ce5f004f396436c6ef7eb)) + +- **api**: Make RESTObjectList typing generic + ([`befba35`](https://github.com/python-gitlab/python-gitlab/commit/befba35a16c5543c5f270996a9bf7a4277482915)) + +- **settings**: Implement support for 'silent_mode_enabled' + ([`a9163a9`](https://github.com/python-gitlab/python-gitlab/commit/a9163a9775b3f9a7b729048fab83bb0bca7228b5)) + +### Refactoring + +- Use more python3.9 syntax + ([`4e90c11`](https://github.com/python-gitlab/python-gitlab/commit/4e90c113f1af768b8b049f4a64c5978a1bfbf323)) + +### Testing + +- **functional**: Switch to new runner registration API + ([`cbc613d`](https://github.com/python-gitlab/python-gitlab/commit/cbc613d0f2ccd8ec021bf789b337104489a3e5f1)) + ## v5.6.0 (2025-01-28) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 90c6c1e70..4da710499 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,6 +9,42 @@ You can contribute to the project in multiple ways: * Add unit and functional tests * Everything else you can think of +Issue Management and Our Approach to Contributions +-------------------------------------------------- + +We value every contribution and bug report. However, as an open-source project +with limited maintainer resources, we rely heavily on the community to help us +move forward. + +**Our Policy on Inactive Issues:** + +To keep our issue tracker manageable and focused on actionable items, we have +the following approach: + +* **We encourage reporters to propose solutions:** If you report an issue, we + strongly encourage you to also think about how it might be fixed and try to + implement that fix. +* **Community interest is key:** Issues that garner interest from the community + (e.g., multiple users confirming, discussions on solutions, offers to help) + are more likely to be addressed. +* **Closing inactive issues:** If an issue report doesn't receive a proposed + fix from the original reporter or anyone else in the community, and there's + no active discussion or indication that someone is willing to work on it + after a reasonable period, it may be closed. + + * When closing such an issue, we will typically leave a comment explaining + that it's being closed due to inactivity and a lack of a proposed fix. + +* **Reopening issues:** This doesn't mean the issue isn't valid. If you (or + someone else) are interested in working on a fix for a closed issue, please + comment on the issue. We are more than happy to reopen it and discuss your + proposed pull request or solution. We greatly appreciate it when community + members take ownership of fixing issues they care about. + +We believe this approach helps us focus our efforts effectively and empowers +the community to contribute directly to the areas they are most passionate +about. + Development workflow -------------------- @@ -158,6 +194,32 @@ To cleanup the environment delete the container: docker rm -f gitlab-test docker rm -f gitlab-runner-test +Pass options to ``pytest`` +-------------------------- + +Options to ``pytest`` can be passed by adding them after ``--`` when running ``tox``: + +.. code-block:: bash + + tox -e api_func_v4 -- . + +For example, you can use this to run a specific test. Running all tests can be time-consuming, +so this allows you to focus on just the tests relevant to your changes. You can do this by passing +the ``-k`` flag to ``pytest`` and setting a relevant expression to select the tests to run. For example: + +.. code-block:: bash + + # Run all API functional tests from the ``test_projects.py`` file: + tox -e api_func_v4 -- --keep-containers -k test_projects.py + + # Run only the ``test_get_project`` test method from the ``test_projects.py`` file: + tox -e api_func_v4 -- --keep-containers -k "test_projects.py and test_create_project" + + # The above will select all test methods start with ``test_create_project`` from the ``test_projects.py`` file. + # To select only the ``test_create_project`` method, you can exclude other methods by using the ``not`` operator: + tox -e api_func_v4 -- --keep-containers -k "test_projects.py and test_create_project and not test_create_project_" + + Rerunning failed CI workflows ----------------------------- diff --git a/README.rst b/README.rst index 101add1eb..1b7b7ce48 100644 --- a/README.rst +++ b/README.rst @@ -53,7 +53,7 @@ Features Installation ------------ -As of 5.0.0, ``python-gitlab`` is compatible with Python 3.9+. +As of 7.0.0, ``python-gitlab`` is compatible with Python 3.10+. Use ``pip`` to install the latest stable version of ``python-gitlab``: diff --git a/docs/api-objects.rst b/docs/api-objects.rst index d8e038ff5..7107107c2 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -24,7 +24,7 @@ API examples gl_objects/environments gl_objects/events gl_objects/epics - gl_objects/features + gl_objects/gitlab_features gl_objects/geo_nodes gl_objects/groups gl_objects/group_access_tokens @@ -36,6 +36,7 @@ API examples gl_objects/boards gl_objects/labels gl_objects/notifications + gl_objects/member_roles.rst gl_objects/merge_trains gl_objects/merge_requests gl_objects/merge_request_approvals.rst @@ -48,6 +49,8 @@ API examples gl_objects/pipelines_and_jobs gl_objects/projects gl_objects/project_access_tokens + gl_objects/project_feature_flags + gl_objects/project_feature_flag_user_lists gl_objects/protected_branches gl_objects/protected_container_repositories gl_objects/protected_environments diff --git a/docs/api-usage-graphql.rst b/docs/api-usage-graphql.rst index 539b7ca3d..d20aeeef1 100644 --- a/docs/api-usage-graphql.rst +++ b/docs/api-usage-graphql.rst @@ -49,12 +49,12 @@ Get the result of a query: .. code-block:: python - query = """{ - query { - currentUser { + query = """ + { + currentUser { name - } } + } """ result = gq.execute(query) @@ -63,12 +63,12 @@ Get the result of a query using the async client: .. code-block:: python - query = """{ - query { - currentUser { + query = """ + { + currentUser { name - } } + } """ result = await async_gq.execute(query) diff --git a/docs/api-usage.rst b/docs/api-usage.rst index eca02d483..38836f20f 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -16,7 +16,7 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab`` access token. For the full list of available options and how to obtain these tokens, please see - https://docs.gitlab.com/ee/api/rest/authentication.html. + https://docs.gitlab.com/api/rest/authentication/. .. code-block:: python @@ -39,7 +39,7 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab`` # job token authentication (to be used in CI) # bear in mind the limitations of the API endpoints it supports: - # https://docs.gitlab.com/ee/ci/jobs/ci_job_token.html + # https://docs.gitlab.com/ci/jobs/ci_job_token import os gl = gitlab.Gitlab('https://gitlab.example.com', job_token=os.environ['CI_JOB_TOKEN']) @@ -83,7 +83,7 @@ Note on password authentication ------------------------------- GitLab has long removed password-based basic authentication. You can currently still use the -`resource owner password credentials `_ +`resource owner password credentials `_ flow to obtain an OAuth token. However, we do not recommend this as it will not work with 2FA enabled, and GitLab is removing @@ -364,7 +364,7 @@ order options. At the time of writing, only ``order_by="id"`` works. gl.projects.list(get_all=True) Reference: -https://docs.gitlab.com/ce/api/README.html#keyset-based-pagination +https://docs.gitlab.com/api/rest/#keyset-based-pagination ``list()`` methods can also return a generator object, by passing the argument ``iterator=True``, which will handle the next calls to the API when required. This @@ -392,7 +392,7 @@ The generator exposes extra listing information as received from the server: ``total_pages`` and ``total`` will have a value of ``None``. For more information see: - https://docs.gitlab.com/ee/user/gitlab_com/index.html#pagination-response-headers + https://docs.gitlab.com/user/gitlab_com/index#pagination-response-headers .. note:: Prior to python-gitlab 3.6.0 the argument ``as_list`` was used instead of diff --git a/docs/cli-usage.rst b/docs/cli-usage.rst index 0be22f5e2..d56388e37 100644 --- a/docs/cli-usage.rst +++ b/docs/cli-usage.rst @@ -165,14 +165,14 @@ We recommend that you use `Credential helpers`_ to securely store your tokens. * - ``private_token`` - Your user token. Login/password is not supported. Refer to `the official documentation - `__ + `__ to learn how to obtain a token. * - ``oauth_token`` - An Oauth token for authentication. The Gitlab server must be configured to support this authentication method. * - ``job_token`` - Your job token. See `the official documentation - `__ + `__ to learn how to obtain a token. * - ``api_version`` - GitLab API version to use. Only ``4`` is available since 1.5.0. diff --git a/docs/ext/docstrings.py b/docs/ext/docstrings.py index 4d8d02df7..f71b68cda 100644 --- a/docs/ext/docstrings.py +++ b/docs/ext/docstrings.py @@ -1,9 +1,11 @@ import inspect import os +from typing import Sequence import jinja2 import sphinx import sphinx.ext.napoleon as napoleon +from sphinx.config import _ConfigRebuild from sphinx.ext.napoleon.docstring import GoogleDocstring @@ -20,9 +22,11 @@ def setup(app): app.connect("autodoc-process-docstring", _process_docstring) app.connect("autodoc-skip-member", napoleon._skip_member) - conf = napoleon.Config._config_values + conf: Sequence[tuple[str, bool | None, _ConfigRebuild, set[type]]] = ( + napoleon.Config._config_values + ) - for name, (default, rebuild) in conf.items(): + for name, default, rebuild, _ in conf: app.add_config_value(name, default, rebuild) return {"version": sphinx.__display_version__, "parallel_read_safe": True} diff --git a/docs/gl_objects/access_requests.rst b/docs/gl_objects/access_requests.rst index 339c7d172..c997fe0d7 100644 --- a/docs/gl_objects/access_requests.rst +++ b/docs/gl_objects/access_requests.rst @@ -25,7 +25,7 @@ References + :class:`gitlab.v4.objects.GroupAccessRequestManager` + :attr:`gitlab.v4.objects.Group.accessrequests` -* GitLab API: https://docs.gitlab.com/ce/api/access_requests.html +* GitLab API: https://docs.gitlab.com/api/access_requests Examples -------- diff --git a/docs/gl_objects/appearance.rst b/docs/gl_objects/appearance.rst index 0c0526817..611413d73 100644 --- a/docs/gl_objects/appearance.rst +++ b/docs/gl_objects/appearance.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ApplicationAppearanceManager` + :attr:`gitlab.Gitlab.appearance` -* GitLab API: https://docs.gitlab.com/ce/api/appearance.html +* GitLab API: https://docs.gitlab.com/api/appearance Examples -------- diff --git a/docs/gl_objects/applications.rst b/docs/gl_objects/applications.rst index 24de3b2ba..fea051b25 100644 --- a/docs/gl_objects/applications.rst +++ b/docs/gl_objects/applications.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ApplicationManager` + :attr:`gitlab.Gitlab.applications` -* GitLab API: https://docs.gitlab.com/ce/api/applications.html +* GitLab API: https://docs.gitlab.com/api/applications Examples -------- diff --git a/docs/gl_objects/badges.rst b/docs/gl_objects/badges.rst index 0f650d460..c84308032 100644 --- a/docs/gl_objects/badges.rst +++ b/docs/gl_objects/badges.rst @@ -18,8 +18,8 @@ Reference * GitLab API: - + https://docs.gitlab.com/ce/api/group_badges.html - + https://docs.gitlab.com/ce/api/project_badges.html + + https://docs.gitlab.com/api/group_badges + + https://docs.gitlab.com/api/project_badges Examples -------- diff --git a/docs/gl_objects/boards.rst b/docs/gl_objects/boards.rst index abab5b91b..5031e4bd5 100644 --- a/docs/gl_objects/boards.rst +++ b/docs/gl_objects/boards.rst @@ -23,8 +23,8 @@ Reference * GitLab API: - + https://docs.gitlab.com/ce/api/boards.html - + https://docs.gitlab.com/ce/api/group_boards.html + + https://docs.gitlab.com/api/boards + + https://docs.gitlab.com/api/group_boards Examples -------- @@ -72,8 +72,8 @@ Reference * GitLab API: - + https://docs.gitlab.com/ce/api/boards.html - + https://docs.gitlab.com/ce/api/group_boards.html + + https://docs.gitlab.com/api/boards + + https://docs.gitlab.com/api/group_boards Examples -------- diff --git a/docs/gl_objects/branches.rst b/docs/gl_objects/branches.rst index 1c0d89d0b..823d98b85 100644 --- a/docs/gl_objects/branches.rst +++ b/docs/gl_objects/branches.rst @@ -11,7 +11,7 @@ References + :class:`gitlab.v4.objects.ProjectBranchManager` + :attr:`gitlab.v4.objects.Project.branches` -* GitLab API: https://docs.gitlab.com/ce/api/branches.html +* GitLab API: https://docs.gitlab.com/api/branches Examples -------- diff --git a/docs/gl_objects/bulk_imports.rst b/docs/gl_objects/bulk_imports.rst index b5b3ef89c..6b1458a13 100644 --- a/docs/gl_objects/bulk_imports.rst +++ b/docs/gl_objects/bulk_imports.rst @@ -17,7 +17,7 @@ References + :class:`gitlab.v4.objects.BulkImportEntityManager` + :attr:`gitlab.v4.objects.BulkImport.entities` -* GitLab API: https://docs.gitlab.com/ee/api/bulk_imports.html +* GitLab API: https://docs.gitlab.com/api/bulk_imports Examples -------- diff --git a/docs/gl_objects/ci_lint.rst b/docs/gl_objects/ci_lint.rst index ad2d875e9..69a403eac 100644 --- a/docs/gl_objects/ci_lint.rst +++ b/docs/gl_objects/ci_lint.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.ProjectCiLintManager` + :attr:`gitlab.v4.objects.Project.ci_lint` -* GitLab API: https://docs.gitlab.com/ee/api/lint.html +* GitLab API: https://docs.gitlab.com/api/lint Examples --------- @@ -46,6 +46,18 @@ Lint a project's CI configuration:: assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid print(lint_result.merged_yaml) # Print the merged YAML file +Lint a project's CI configuration from a specific branch or tag:: + + lint_result = project.ci_lint.get(content_ref="main") + assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid + print(lint_result.merged_yaml) # Print the merged YAML file + +Lint a project's CI configuration with dry run simulation:: + + lint_result = project.ci_lint.get(dry_run=True, dry_run_ref="develop") + assert lint_result.valid is True # Test that the .gitlab-ci.yml is valid + print(lint_result.merged_yaml) # Print the merged YAML file + Lint a CI YAML configuration with a namespace:: lint_result = project.ci_lint.create({"content": gitlab_ci_yml}) diff --git a/docs/gl_objects/cluster_agents.rst b/docs/gl_objects/cluster_agents.rst index 9e050b1ed..b9810959d 100644 --- a/docs/gl_objects/cluster_agents.rst +++ b/docs/gl_objects/cluster_agents.rst @@ -17,7 +17,7 @@ Reference + :class:`gitlab.v4.objects.ProjectClusterAgentManager` + :attr:`gitlab.v4.objects.Project.cluster_agents` -* GitLab API: https://docs.gitlab.com/ee/api/cluster_agents.html +* GitLab API: https://docs.gitlab.com/api/cluster_agents Examples -------- diff --git a/docs/gl_objects/clusters.rst b/docs/gl_objects/clusters.rst index 14b64818c..7cf413bc2 100644 --- a/docs/gl_objects/clusters.rst +++ b/docs/gl_objects/clusters.rst @@ -19,8 +19,8 @@ Reference + :class:`gitlab.v4.objects.GroupClusterManager` + :attr:`gitlab.v4.objects.Group.clusters` -* GitLab API: https://docs.gitlab.com/ee/api/project_clusters.html -* GitLab API: https://docs.gitlab.com/ee/api/group_clusters.html +* GitLab API: https://docs.gitlab.com/api/project_clusters +* GitLab API: https://docs.gitlab.com/api/group_clusters Examples -------- diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst index c810442c8..0c612f3de 100644 --- a/docs/gl_objects/commits.rst +++ b/docs/gl_objects/commits.rst @@ -33,7 +33,7 @@ List all commits for a project (see :ref:`pagination`) on all branches: Create a commit:: - # See https://docs.gitlab.com/ce/api/commits.html#create-a-commit-with-multiple-files-and-actions + # See https://docs.gitlab.com/api/commits#create-a-commit-with-multiple-files-and-actions # for actions detail data = { 'branch': 'main', @@ -98,7 +98,7 @@ Reference + :class:`gitlab.v4.objects.ProjectCommitCommentManager` + :attr:`gitlab.v4.objects.ProjectCommit.comments` -* GitLab API: https://docs.gitlab.com/ce/api/commits.html +* GitLab API: https://docs.gitlab.com/api/commits Examples -------- @@ -129,7 +129,7 @@ Reference + :class:`gitlab.v4.objects.ProjectCommitStatusManager` + :attr:`gitlab.v4.objects.ProjectCommit.statuses` -* GitLab API: https://docs.gitlab.com/ce/api/commits.html +* GitLab API: https://docs.gitlab.com/api/commits Examples -------- diff --git a/docs/gl_objects/deploy_keys.rst b/docs/gl_objects/deploy_keys.rst index 65fa01a3d..9f91fea0f 100644 --- a/docs/gl_objects/deploy_keys.rst +++ b/docs/gl_objects/deploy_keys.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.DeployKeyManager` + :attr:`gitlab.Gitlab.deploykeys` -* GitLab API: https://docs.gitlab.com/ce/api/deploy_keys.html +* GitLab API: https://docs.gitlab.com/api/deploy_keys Examples -------- @@ -41,7 +41,7 @@ Reference + :class:`gitlab.v4.objects.ProjectKeyManager` + :attr:`gitlab.v4.objects.Project.keys` -* GitLab API: https://docs.gitlab.com/ce/api/deploy_keys.html +* GitLab API: https://docs.gitlab.com/api/deploy_keys Examples -------- diff --git a/docs/gl_objects/deploy_tokens.rst b/docs/gl_objects/deploy_tokens.rst index 8f06254d2..80c00803a 100644 --- a/docs/gl_objects/deploy_tokens.rst +++ b/docs/gl_objects/deploy_tokens.rst @@ -19,7 +19,7 @@ Reference + :class:`gitlab.v4.objects.DeployTokenManager` + :attr:`gitlab.Gitlab.deploytokens` -* GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html +* GitLab API: https://docs.gitlab.com/api/deploy_tokens Examples -------- @@ -45,7 +45,7 @@ Reference + :class:`gitlab.v4.objects.ProjectDeployTokenManager` + :attr:`gitlab.v4.objects.Project.deploytokens` -* GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html#project-deploy-tokens +* GitLab API: https://docs.gitlab.com/api/deploy_tokens#project-deploy-tokens Examples -------- @@ -102,7 +102,7 @@ Reference + :class:`gitlab.v4.objects.GroupDeployTokenManager` + :attr:`gitlab.v4.objects.Group.deploytokens` -* GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html#group-deploy-tokens +* GitLab API: https://docs.gitlab.com/api/deploy_tokens#group-deploy-tokens Examples -------- diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst index 10de426c2..4be927af7 100644 --- a/docs/gl_objects/deployments.rst +++ b/docs/gl_objects/deployments.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ProjectDeploymentManager` + :attr:`gitlab.v4.objects.Project.deployments` -* GitLab API: https://docs.gitlab.com/ce/api/deployments.html +* GitLab API: https://docs.gitlab.com/api/deployments Examples -------- @@ -64,7 +64,7 @@ Reference + :class:`gitlab.v4.objects.ProjectDeploymentMergeRequestManager` + :attr:`gitlab.v4.objects.ProjectDeployment.mergerequests` -* GitLab API: https://docs.gitlab.com/ee/api/deployments.html#list-of-merge-requests-associated-with-a-deployment +* GitLab API: https://docs.gitlab.com/api/deployments#list-of-merge-requests-associated-with-a-deployment Examples -------- diff --git a/docs/gl_objects/discussions.rst b/docs/gl_objects/discussions.rst index 6d493044b..f64a98b3d 100644 --- a/docs/gl_objects/discussions.rst +++ b/docs/gl_objects/discussions.rst @@ -37,7 +37,7 @@ Reference + :class:`gitlab.v4.objects.ProjectSnippetDiscussionNoteManager` + :attr:`gitlab.v4.objects.ProjectSnippet.notes` -* GitLab API: https://docs.gitlab.com/ce/api/discussions.html +* GitLab API: https://docs.gitlab.com/api/discussions Examples ======== diff --git a/docs/gl_objects/draft_notes.rst b/docs/gl_objects/draft_notes.rst index 5cc84eeb2..8f33de6e6 100644 --- a/docs/gl_objects/draft_notes.rst +++ b/docs/gl_objects/draft_notes.rst @@ -18,7 +18,7 @@ Reference + :attr:`gitlab.v4.objects.ProjectMergeRequest.draft_notes` -* GitLab API: https://docs.gitlab.com/ee/api/draft_notes.html +* GitLab API: https://docs.gitlab.com/api/draft_notes Examples -------- diff --git a/docs/gl_objects/emojis.rst b/docs/gl_objects/emojis.rst index f19f3b1d0..1675916e1 100644 --- a/docs/gl_objects/emojis.rst +++ b/docs/gl_objects/emojis.rst @@ -21,7 +21,7 @@ Reference + :class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmojiManager` -* GitLab API: https://docs.gitlab.com/ce/api/award_emoji.html +* GitLab API: https://docs.gitlab.com/api/emoji_reactions/ Examples -------- diff --git a/docs/gl_objects/environments.rst b/docs/gl_objects/environments.rst index 164a9c9a0..382820b76 100644 --- a/docs/gl_objects/environments.rst +++ b/docs/gl_objects/environments.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ProjectEnvironmentManager` + :attr:`gitlab.v4.objects.Project.environments` -* GitLab API: https://docs.gitlab.com/ce/api/environments.html +* GitLab API: https://docs.gitlab.com/api/environments Examples -------- diff --git a/docs/gl_objects/epics.rst b/docs/gl_objects/epics.rst index 33ef2b848..7e43aaa8e 100644 --- a/docs/gl_objects/epics.rst +++ b/docs/gl_objects/epics.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.GroupEpicManager` + :attr:`gitlab.Gitlab.Group.epics` -* GitLab API: https://docs.gitlab.com/ee/api/epics.html (EE feature) +* GitLab API: https://docs.gitlab.com/api/epics (EE feature) Examples -------- @@ -53,7 +53,7 @@ Reference + :class:`gitlab.v4.objects.GroupEpicIssueManager` + :attr:`gitlab.Gitlab.GroupEpic.issues` -* GitLab API: https://docs.gitlab.com/ee/api/epic_issues.html (EE feature) +* GitLab API: https://docs.gitlab.com/api/epic_issues (EE feature) Examples -------- diff --git a/docs/gl_objects/events.rst b/docs/gl_objects/events.rst index 68a55b92f..108f6cedb 100644 --- a/docs/gl_objects/events.rst +++ b/docs/gl_objects/events.rst @@ -20,7 +20,7 @@ Reference + :class:`gitlab.v4.objects.UserEventManager` + :attr:`gitlab.v4.objects.User.events` -* GitLab API: https://docs.gitlab.com/ce/api/events.html +* GitLab API: https://docs.gitlab.com/api/events/ Examples -------- @@ -29,7 +29,7 @@ You can list events for an entire Gitlab instance (admin), users and projects. You can filter you events you want to retrieve using the ``action`` and ``target_type`` attributes. The possible values for these attributes are available on `the gitlab documentation -`_. +`_. List all the events (paginated):: @@ -58,7 +58,7 @@ Reference + :class:`gitlab.v4.objects.ProjectMergeRequestResourceStateEventManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcestateevents` -* GitLab API: https://docs.gitlab.com/ee/api/resource_state_events.html +* GitLab API: https://docs.gitlab.com/api/resource_state_events Examples -------- diff --git a/docs/gl_objects/geo_nodes.rst b/docs/gl_objects/geo_nodes.rst index 878798262..4eb1932ed 100644 --- a/docs/gl_objects/geo_nodes.rst +++ b/docs/gl_objects/geo_nodes.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.GeoNodeManager` + :attr:`gitlab.Gitlab.geonodes` -* GitLab API: https://docs.gitlab.com/ee/api/geo_nodes.html (EE feature) +* GitLab API: https://docs.gitlab.com/api/geo_nodes (EE feature) Examples -------- diff --git a/docs/gl_objects/features.rst b/docs/gl_objects/gitlab_features.rst similarity index 58% rename from docs/gl_objects/features.rst rename to docs/gl_objects/gitlab_features.rst index 6ed758e97..7df506b09 100644 --- a/docs/gl_objects/features.rst +++ b/docs/gl_objects/gitlab_features.rst @@ -1,6 +1,11 @@ -############## -Features flags -############## +################################ +GitLab Development Feature Flags +################################ + +.. note:: + + This API is for managing GitLab's internal development feature flags and requires administrator access. + For project-level feature flags, see :doc:`project_feature_flags`. Reference --------- @@ -11,7 +16,7 @@ Reference + :class:`gitlab.v4.objects.FeatureManager` + :attr:`gitlab.Gitlab.features` -* GitLab API: https://docs.gitlab.com/ce/api/features.html +* GitLab API: https://docs.gitlab.com/api/features Examples -------- @@ -29,4 +34,4 @@ Create or set a feature:: Delete a feature:: - feature.delete() + feature.delete() \ No newline at end of file diff --git a/docs/gl_objects/group_access_tokens.rst b/docs/gl_objects/group_access_tokens.rst index b3b0132d4..26c694e5b 100644 --- a/docs/gl_objects/group_access_tokens.rst +++ b/docs/gl_objects/group_access_tokens.rst @@ -13,7 +13,7 @@ References + :class:`gitlab.v4.objects.GroupAccessTokenManager` + :attr:`gitlab.Gitlab.group_access_tokens` -* GitLab API: https://docs.gitlab.com/ee/api/group_access_tokens.html +* GitLab API: https://docs.gitlab.com/api/group_access_tokens Examples -------- @@ -46,3 +46,9 @@ Rotate a group access token and retrieve its new value:: # or directly using a token ID new_token = group.access_tokens.rotate(42) print(new_token.token) + +Self-Rotate the group access token you are using to authenticate the request and retrieve its new value:: + + token = group.access_tokens.get(42, lazy=True) + token.rotate(self_rotate=True) + print(token.token) \ No newline at end of file diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst index 2acc57d9e..7824ef31b 100644 --- a/docs/gl_objects/groups.rst +++ b/docs/gl_objects/groups.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.GroupManager` + :attr:`gitlab.Gitlab.groups` -* GitLab API: https://docs.gitlab.com/ce/api/groups.html +* GitLab API: https://docs.gitlab.com/api/groups Examples -------- @@ -63,7 +63,7 @@ Create a group:: .. warning:: On GitLab.com, creating top-level groups is currently - `not permitted using the API `_. + `not permitted using the API `_. You can only use the API to create subgroups. Create a subgroup under an existing group:: @@ -82,6 +82,11 @@ Set the avatar image for a group:: group.avatar = open('path/to/file.png', 'rb') group.save() +Remove the avatar image for a group:: + + group.avatar = "" + group.save() + Remove a group:: gl.groups.delete(group_id) @@ -116,7 +121,7 @@ Reference + :attr:`gitlab.v4.objects.Group.imports` + :attr:`gitlab.v4.objects.GroupManager.import_group` -* GitLab API: https://docs.gitlab.com/ce/api/group_import_export.html +* GitLab API: https://docs.gitlab.com/api/group_import_export Examples -------- @@ -219,7 +224,7 @@ Reference + :class:`gitlab.v4.objects.GroupCustomAttributeManager` + :attr:`gitlab.v4.objects.Group.customattributes` -* GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html +* GitLab API: https://docs.gitlab.com/api/custom_attributes Examples -------- @@ -272,7 +277,7 @@ Reference + :attr:`gitlab.v4.objects.Group.members_all` + :attr:`gitlab.v4.objects.Group.billable_members` -* GitLab API: https://docs.gitlab.com/ce/api/members.html +* GitLab API: https://docs.gitlab.com/api/members Billable group members are only available in GitLab EE. @@ -397,7 +402,7 @@ Reference + :class:`gitlab.v4.objects.GroupHookManager` + :attr:`gitlab.v4.objects.Group.hooks` -* GitLab API: https://docs.gitlab.com/ce/api/groups.html#hooks +* GitLab API: https://docs.gitlab.com/api/groups#hooks Examples -------- @@ -441,7 +446,7 @@ Reference + :class:`gitlab.v4.objects.GroupPushRulesManager` + :attr:`gitlab.v4.objects.Group.pushrules` -* GitLab API: https://docs.gitlab.com/ee/api/groups.html#push-rules +* GitLab API: https://docs.gitlab.com/api/groups#push-rules Examples --------- @@ -475,7 +480,7 @@ Reference + :class:`gitlab.v4.objects.GroupServiceAccountManager` + :attr:`gitlab.v4.objects.Group.serviceaccounts` -* GitLab API: https://docs.gitlab.com/ee/api/groups.html#service-accounts +* GitLab API: https://docs.gitlab.com/api/groups#service-accounts Examples --------- diff --git a/docs/gl_objects/invitations.rst b/docs/gl_objects/invitations.rst index 795828b3c..e88564f6d 100644 --- a/docs/gl_objects/invitations.rst +++ b/docs/gl_objects/invitations.rst @@ -16,7 +16,7 @@ Reference + :class:`gitlab.v4.objects.ProjectInvitationManager` + :attr:`gitlab.v4.objects.Project.invitations` -* GitLab API: https://docs.gitlab.com/ce/api/invitations.html +* GitLab API: https://docs.gitlab.com/api/invitations Examples -------- diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst index 1b7e6472e..ea17af728 100644 --- a/docs/gl_objects/issues.rst +++ b/docs/gl_objects/issues.rst @@ -16,7 +16,7 @@ Reference + :class:`gitlab.v4.objects.IssueManager` + :attr:`gitlab.Gitlab.issues` -* GitLab API: https://docs.gitlab.com/ce/api/issues.html +* GitLab API: https://docs.gitlab.com/api/issues Examples -------- @@ -55,7 +55,7 @@ Reference + :class:`gitlab.v4.objects.GroupIssueManager` + :attr:`gitlab.v4.objects.Group.issues` -* GitLab API: https://docs.gitlab.com/ce/api/issues.html +* GitLab API: https://docs.gitlab.com/api/issues Examples -------- @@ -91,7 +91,7 @@ Reference + :class:`gitlab.v4.objects.ProjectIssueManager` + :attr:`gitlab.v4.objects.Project.issues` -* GitLab API: https://docs.gitlab.com/ce/api/issues.html +* GitLab API: https://docs.gitlab.com/api/issues Examples -------- @@ -223,7 +223,7 @@ Reference + :class:`gitlab.v4.objects.ProjectIssueLinkManager` + :attr:`gitlab.v4.objects.ProjectIssue.links` -* GitLab API: https://docs.gitlab.com/ee/api/issue_links.html +* GitLab API: https://docs.gitlab.com/api/issue_links Examples -------- @@ -268,7 +268,7 @@ Reference + :attr:`gitlab.v4.objects.Project.issues_statistics` -* GitLab API: https://docs.gitlab.com/ce/api/issues_statistics.htm +* GitLab API: https://docs.gitlab.com/api/issues_statistics/ Examples --------- diff --git a/docs/gl_objects/iterations.rst b/docs/gl_objects/iterations.rst index 812dece6d..3f5e763bf 100644 --- a/docs/gl_objects/iterations.rst +++ b/docs/gl_objects/iterations.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.ProjectIterationManager` + :attr:`gitlab.v4.objects.Project.iterations` -* GitLab API: https://docs.gitlab.com/ee/api/iterations.html +* GitLab API: https://docs.gitlab.com/api/iterations Examples -------- diff --git a/docs/gl_objects/job_token_scope.rst b/docs/gl_objects/job_token_scope.rst index 22fbbccea..8857e2251 100644 --- a/docs/gl_objects/job_token_scope.rst +++ b/docs/gl_objects/job_token_scope.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ProjectJobTokenScopeManager` + :attr:`gitlab.v4.objects.Project.job_token_scope` -* GitLab API: https://docs.gitlab.com/ee/api/project_job_token_scopes.html +* GitLab API: https://docs.gitlab.com/api/project_job_token_scopes Examples -------- @@ -82,13 +82,13 @@ Get a project's CI/CD job token inbound groups allowlist:: allowlist = scope.groups_allowlist.list(get_all=True) -Add a project to the project's inbound groups allowlist:: +Add a group to the project's inbound groups allowlist:: - allowed_project = scope.groups_allowlist.create({"target_project_id": 42}) + allowed_group = scope.groups_allowlist.create({"target_group_id": 42}) -Remove a project from the project's inbound agroups llowlist:: +Remove a group from the project's inbound groups allowlist:: - allowed_project.delete() + allowed_group.delete() # or directly using a Group ID scope.groups_allowlist.delete(42) @@ -97,4 +97,3 @@ Remove a project from the project's inbound agroups llowlist:: Similar to above, the ID attributes you receive from the create and list APIs are not consistent. To safely retrieve the ID of the allowlisted group regardless of how the object was created, always use its ``.get_id()`` method. - diff --git a/docs/gl_objects/keys.rst b/docs/gl_objects/keys.rst index 6d3521809..4450ed708 100644 --- a/docs/gl_objects/keys.rst +++ b/docs/gl_objects/keys.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.KeyManager` + :attr:`gitlab.Gitlab.keys` -* GitLab API: https://docs.gitlab.com/ce/api/keys.html +* GitLab API: https://docs.gitlab.com/api/keys Examples -------- diff --git a/docs/gl_objects/labels.rst b/docs/gl_objects/labels.rst index b3ae9562b..7fa042fab 100644 --- a/docs/gl_objects/labels.rst +++ b/docs/gl_objects/labels.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.ProjectLabelManager` + :attr:`gitlab.v4.objects.Project.labels` -* GitLab API: https://docs.gitlab.com/ce/api/labels.html +* GitLab API: https://docs.gitlab.com/api/labels Examples -------- @@ -79,7 +79,7 @@ Reference + :class:`gitlab.v4.objects.GroupEpicResourceLabelEventManager` + :attr:`gitlab.v4.objects.GroupEpic.resourcelabelevents` -* GitLab API: https://docs.gitlab.com/ee/api/resource_label_events.html +* GitLab API: https://docs.gitlab.com/api/resource_label_events Examples -------- diff --git a/docs/gl_objects/member_roles.rst b/docs/gl_objects/member_roles.rst new file mode 100644 index 000000000..1c4aa07c5 --- /dev/null +++ b/docs/gl_objects/member_roles.rst @@ -0,0 +1,71 @@ +############ +Member Roles +############ + +You can configure member roles at the instance-level (admin only), or +at group level. + +Instance-level member roles +=========================== + +This endpoint requires admin access. + +Reference +--------- + +* v4 API + + + :class:`gitlab.v4.objects.MemberRole` + + :class:`gitlab.v4.objects.MemberRoleManager` + + :attr:`gitlab.Gitlab.member_roles` + +* GitLab API + + + https://docs.gitlab.com/api/member_roles#manage-instance-member-roles + +Examples +-------- + +List member roles:: + + variables = gl.member_roles.list() + +Create a member role:: + + variable = gl.member_roles.create({'name': 'Custom Role', 'base_access_level': value}) + +Remove a member role:: + + gl.member_roles.delete(member_role_id) + +Group member role +================= + +Reference +--------- + +* v4 API + + + :class:`gitlab.v4.objects.GroupMemberRole` + + :class:`gitlab.v4.objects.GroupMemberRoleManager` + + :attr:`gitlab.v4.objects.Group.member_roles` + +* GitLab API + + + https://docs.gitlab.com/api/member_roles#manage-group-member-roles + +Examples +-------- + +List member roles:: + + member_roles = group.member_roles.list() + +Create a member role:: + + member_roles = group.member_roles.create({'name': 'Custom Role', 'base_access_level': value}) + +Remove a member role:: + + gl.member_roles.delete(member_role_id) + diff --git a/docs/gl_objects/merge_request_approvals.rst b/docs/gl_objects/merge_request_approvals.rst index 5925b1a4d..4f9d561bb 100644 --- a/docs/gl_objects/merge_request_approvals.rst +++ b/docs/gl_objects/merge_request_approvals.rst @@ -15,7 +15,7 @@ References + :class:`gitlab.v4.objects.GroupApprovalRule` + :class:`gitlab.v4.objects.GroupApprovalRuleManager` -* GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html +* GitLab API: https://docs.gitlab.com/api/merge_request_approvals Examples -------- @@ -55,7 +55,7 @@ References + :class:`gitlab.v4.objects.ProjectApprovalRuleManager` + :attr:`gitlab.v4.objects.Project.approvals` -* GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html +* GitLab API: https://docs.gitlab.com/api/merge_request_approvals Examples -------- @@ -101,7 +101,7 @@ References + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalStateManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.approval_state` -* GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html +* GitLab API: https://docs.gitlab.com/api/merge_request_approvals Examples -------- diff --git a/docs/gl_objects/merge_requests.rst b/docs/gl_objects/merge_requests.rst index 716b0e5e3..0bb861c72 100644 --- a/docs/gl_objects/merge_requests.rst +++ b/docs/gl_objects/merge_requests.rst @@ -25,7 +25,7 @@ Reference + :class:`gitlab.v4.objects.MergeRequestManager` + :attr:`gitlab.Gitlab.mergerequests` -* GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html +* GitLab API: https://docs.gitlab.com/api/merge_requests Examples -------- @@ -67,7 +67,7 @@ Reference + :class:`gitlab.v4.objects.ProjectMergeRequestManager` + :attr:`gitlab.v4.objects.Project.mergerequests` -* GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html +* GitLab API: https://docs.gitlab.com/api/merge_requests Examples -------- @@ -84,7 +84,7 @@ You can filter and sort the returned list with the following parameters: * ``sort``: sort order (``asc`` or ``desc``) You can find a full updated list of parameters here: -https://docs.gitlab.com/ee/api/merge_requests.html#list-merge-requests +https://docs.gitlab.com/api/merge_requests#list-merge-requests For example:: @@ -221,7 +221,7 @@ Get status of a rebase for an MR:: print(mr.rebase_in_progress, mr.merge_error) For more info see: -https://docs.gitlab.com/ee/api/merge_requests.html#rebase-a-merge-request +https://docs.gitlab.com/api/merge_requests#rebase-a-merge-request Attempt to merge changes between source and target branch:: @@ -240,7 +240,7 @@ Reference + :class:`gitlab.v4.objects.ProjectMergeRequestPipelineManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.pipelines` -* GitLab API: https://docs.gitlab.com/ee/api/merge_requests.html#list-mr-pipelines +* GitLab API: https://docs.gitlab.com/api/merge_requests#list-mr-pipelines Examples -------- diff --git a/docs/gl_objects/merge_trains.rst b/docs/gl_objects/merge_trains.rst index c7754727d..6d98e04d8 100644 --- a/docs/gl_objects/merge_trains.rst +++ b/docs/gl_objects/merge_trains.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ProjectMergeTrainManager` + :attr:`gitlab.v4.objects.Project.merge_trains` -* GitLab API: https://docs.gitlab.com/ee/api/merge_trains.html +* GitLab API: https://docs.gitlab.com/api/merge_trains Examples -------- diff --git a/docs/gl_objects/messages.rst b/docs/gl_objects/messages.rst index fa9c229fd..a7dbabbe7 100644 --- a/docs/gl_objects/messages.rst +++ b/docs/gl_objects/messages.rst @@ -15,7 +15,7 @@ References + :class:`gitlab.v4.objects.BroadcastMessageManager` + :attr:`gitlab.Gitlab.broadcastmessages` -* GitLab API: https://docs.gitlab.com/ce/api/broadcast_messages.html +* GitLab API: https://docs.gitlab.com/api/broadcast_messages Examples -------- diff --git a/docs/gl_objects/milestones.rst b/docs/gl_objects/milestones.rst index 4a1a5971e..7a02859db 100644 --- a/docs/gl_objects/milestones.rst +++ b/docs/gl_objects/milestones.rst @@ -20,8 +20,8 @@ Reference * GitLab API: - + https://docs.gitlab.com/ce/api/milestones.html - + https://docs.gitlab.com/ce/api/group_milestones.html + + https://docs.gitlab.com/api/milestones + + https://docs.gitlab.com/api/group_milestones Examples -------- @@ -95,7 +95,7 @@ Reference + :class:`gitlab.v4.objects.ProjectMergeRequestResourceMilestoneEventManager` + :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcemilestoneevents` -* GitLab API: https://docs.gitlab.com/ee/api/resource_milestone_events.html +* GitLab API: https://docs.gitlab.com/api/resource_milestone_events Examples -------- diff --git a/docs/gl_objects/namespaces.rst b/docs/gl_objects/namespaces.rst index bcfa5d2db..7c8eeb5e6 100644 --- a/docs/gl_objects/namespaces.rst +++ b/docs/gl_objects/namespaces.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.NamespaceManager` + :attr:`gitlab.Gitlab.namespaces` -* GitLab API: https://docs.gitlab.com/ce/api/namespaces.html +* GitLab API: https://docs.gitlab.com/api/namespaces Examples -------- diff --git a/docs/gl_objects/notes.rst b/docs/gl_objects/notes.rst index 86c8b324d..d9c3d6824 100644 --- a/docs/gl_objects/notes.rst +++ b/docs/gl_objects/notes.rst @@ -36,7 +36,7 @@ Reference + :class:`gitlab.v4.objects.ProjectSnippetNoteManager` + :attr:`gitlab.v4.objects.ProjectSnippet.notes` -* GitLab API: https://docs.gitlab.com/ce/api/notes.html +* GitLab API: https://docs.gitlab.com/api/notes Examples -------- diff --git a/docs/gl_objects/notifications.rst b/docs/gl_objects/notifications.rst index bc97b1ae9..3c5c7bd33 100644 --- a/docs/gl_objects/notifications.rst +++ b/docs/gl_objects/notifications.rst @@ -30,7 +30,7 @@ Reference + :class:`gitlab.v4.objects.ProjectNotificationSettingsManager` + :attr:`gitlab.v4.objects.Project.notificationsettings` -* GitLab API: https://docs.gitlab.com/ce/api/notification_settings.html +* GitLab API: https://docs.gitlab.com/api/notification_settings Examples -------- diff --git a/docs/gl_objects/packages.rst b/docs/gl_objects/packages.rst index cd101500f..369f8f9f4 100644 --- a/docs/gl_objects/packages.rst +++ b/docs/gl_objects/packages.rst @@ -17,7 +17,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPackageManager` + :attr:`gitlab.v4.objects.Project.packages` -* GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-project +* GitLab API: https://docs.gitlab.com/api/packages#within-a-project Examples -------- @@ -53,7 +53,7 @@ Reference + :class:`gitlab.v4.objects.GroupPackageManager` + :attr:`gitlab.v4.objects.Group.packages` -* GitLab API: https://docs.gitlab.com/ee/api/packages.html#within-a-group +* GitLab API: https://docs.gitlab.com/api/packages#within-a-group Examples -------- @@ -79,7 +79,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPackageFileManager` + :attr:`gitlab.v4.objects.ProjectPackage.package_files` -* GitLab API: https://docs.gitlab.com/ee/api/packages.html#list-package-files +* GitLab API: https://docs.gitlab.com/api/packages#list-package-files Examples -------- @@ -107,7 +107,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPackagePipelineManager` + :attr:`gitlab.v4.objects.ProjectPackage.pipelines` -* GitLab API: https://docs.gitlab.com/ee/api/packages.html#list-package-pipelines +* GitLab API: https://docs.gitlab.com/api/packages#list-package-pipelines Examples -------- @@ -131,7 +131,7 @@ Reference + :class:`gitlab.v4.objects.GenericPackageManager` + :attr:`gitlab.v4.objects.Project.generic_packages` -* GitLab API: https://docs.gitlab.com/ee/user/packages/generic_packages +* GitLab API: https://docs.gitlab.com/user/packages/generic_packages Examples -------- diff --git a/docs/gl_objects/pagesdomains.rst b/docs/gl_objects/pagesdomains.rst index f6c1e7696..85887cf02 100644 --- a/docs/gl_objects/pagesdomains.rst +++ b/docs/gl_objects/pagesdomains.rst @@ -14,7 +14,7 @@ References + :class:`gitlab.v4.objects.ProjectPagesManager` + :attr:`gitlab.v4.objects.Project.pages` -* GitLab API: https://docs.gitlab.com/ee/api/pages.html +* GitLab API: https://docs.gitlab.com/api/pages Examples -------- @@ -43,7 +43,7 @@ References + :class:`gitlab.v4.objects.PagesDomainManager` + :attr:`gitlab.Gitlab.pagesdomains` -* GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-all-pages-domains +* GitLab API: https://docs.gitlab.com/api/pages_domains#list-all-pages-domains Examples -------- @@ -64,7 +64,7 @@ References + :class:`gitlab.v4.objects.ProjectPagesDomainManager` + :attr:`gitlab.v4.objects.Project.pagesdomains` -* GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-pages-domains +* GitLab API: https://docs.gitlab.com/api/pages_domains#list-pages-domains Examples -------- diff --git a/docs/gl_objects/personal_access_tokens.rst b/docs/gl_objects/personal_access_tokens.rst index ad6778175..d9d54b596 100644 --- a/docs/gl_objects/personal_access_tokens.rst +++ b/docs/gl_objects/personal_access_tokens.rst @@ -16,8 +16,8 @@ References * GitLab API: - + https://docs.gitlab.com/ee/api/personal_access_tokens.html - + https://docs.gitlab.com/ee/api/users.html#create-a-personal-access-token + + https://docs.gitlab.com/api/personal_access_tokens + + https://docs.gitlab.com/api/users#create-a-personal-access-token Examples -------- @@ -61,6 +61,12 @@ Rotate a personal access token and retrieve its new value:: new_token_dict = gl.personal_access_tokens.rotate(42) print(new_token_dict) +Self-Rotate the personal access token you are using to authenticate the request and retrieve its new value:: + + token = gl.personal_access_tokens.get(42, lazy=True) + token.rotate(self_rotate=True) + print(token.token) + Create a personal access token for a user (admin only):: user = gl.users.get(25, lazy=True) diff --git a/docs/gl_objects/pipelines_and_jobs.rst b/docs/gl_objects/pipelines_and_jobs.rst index 9315142cf..8b533b407 100644 --- a/docs/gl_objects/pipelines_and_jobs.rst +++ b/docs/gl_objects/pipelines_and_jobs.rst @@ -16,7 +16,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPipelineManager` + :attr:`gitlab.v4.objects.Project.pipelines` -* GitLab API: https://docs.gitlab.com/ce/api/pipelines.html +* GitLab API: https://docs.gitlab.com/api/pipelines Examples -------- @@ -69,7 +69,7 @@ Reference + :class:`gitlab.v4.objects.ProjectTriggerManager` + :attr:`gitlab.v4.objects.Project.triggers` -* GitLab API: https://docs.gitlab.com/ce/api/pipeline_triggers.html +* GitLab API: https://docs.gitlab.com/api/pipeline_triggers Examples -------- @@ -115,7 +115,7 @@ objects to get the associated project:: project = gl.projects.get(project_id, lazy=True) # no API call project.trigger_pipeline('main', trigger_token) -Reference: https://docs.gitlab.com/ee/ci/triggers/#trigger-token +Reference: https://docs.gitlab.com/ci/triggers/#trigger-token Pipeline schedules ================== @@ -138,7 +138,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPipelineSchedulePipelineManager` + :attr:`gitlab.v4.objects.ProjectPipelineSchedule.pipelines` -* GitLab API: https://docs.gitlab.com/ce/api/pipeline_schedules.html +* GitLab API: https://docs.gitlab.com/api/pipeline_schedules Examples -------- @@ -216,7 +216,7 @@ Reference + :class:`gitlab.v4.objects.ProjectJobManager` + :attr:`gitlab.v4.objects.Project.jobs` -* GitLab API: https://docs.gitlab.com/ce/api/jobs.html +* GitLab API: https://docs.gitlab.com/api/jobs Examples -------- @@ -350,7 +350,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPipelineBridgeManager` + :attr:`gitlab.v4.objects.ProjectPipeline.bridges` -* GitLab API: https://docs.gitlab.com/ee/api/jobs.html#list-pipeline-bridges +* GitLab API: https://docs.gitlab.com/api/jobs#list-pipeline-bridges Examples -------- @@ -373,7 +373,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPipelineTestReportManager` + :attr:`gitlab.v4.objects.ProjectPipeline.test_report` -* GitLab API: https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report +* GitLab API: https://docs.gitlab.com/api/pipelines#get-a-pipelines-test-report Examples -------- @@ -396,7 +396,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPipelineTestReportSummaryManager` + :attr:`gitlab.v4.objects.ProjectPipeline.test_report_summary` -* GitLab API: https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report-summary +* GitLab API: https://docs.gitlab.com/api/pipelines#get-a-pipelines-test-report-summary Examples -------- diff --git a/docs/gl_objects/project_access_tokens.rst b/docs/gl_objects/project_access_tokens.rst index 8d89f886d..6088e4d55 100644 --- a/docs/gl_objects/project_access_tokens.rst +++ b/docs/gl_objects/project_access_tokens.rst @@ -13,7 +13,7 @@ References + :class:`gitlab.v4.objects.ProjectAccessTokenManager` + :attr:`gitlab.Gitlab.project_access_tokens` -* GitLab API: https://docs.gitlab.com/ee/api/project_access_tokens.html +* GitLab API: https://docs.gitlab.com/api/project_access_tokens Examples -------- @@ -46,3 +46,9 @@ Rotate a project access token and retrieve its new value:: # or directly using a token ID new_token = project.access_tokens.rotate(42) print(new_token.token) + +Self-Rotate the project access token you are using to authenticate the request and retrieve its new value:: + + token = project.access_tokens.get(42, lazy=True) + token.rotate(self_rotate=True) + print(new_token.token) \ No newline at end of file diff --git a/docs/gl_objects/project_feature_flag_user_lists.rst b/docs/gl_objects/project_feature_flag_user_lists.rst new file mode 100644 index 000000000..9e25ceb44 --- /dev/null +++ b/docs/gl_objects/project_feature_flag_user_lists.rst @@ -0,0 +1,51 @@ +############################### +Project Feature Flag User Lists +############################### + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectFeatureFlagUserList` + + :class:`gitlab.v4.objects.ProjectFeatureFlagUserListManager` + + :attr:`gitlab.v4.objects.Project.feature_flags_user_lists` + +* GitLab API: https://docs.gitlab.com/api/feature_flag_user_lists + +Examples +-------- + +List user lists:: + + user_lists = project.feature_flags_user_lists.list() + +Get a user list:: + + user_list = project.feature_flags_user_lists.get(list_iid) + +Create a user list:: + + user_list = project.feature_flags_user_lists.create({ + 'name': 'my_user_list', + 'user_xids': 'user1,user2,user3' + }) + +Update a user list:: + + user_list.name = 'updated_list_name' + user_list.user_xids = 'user1,user2' + user_list.save() + +Delete a user list:: + + user_list.delete() + +Search for a user list:: + + user_lists = project.feature_flags_user_lists.list(search='my_list') + +See also +-------- + +* :doc:`project_feature_flags` diff --git a/docs/gl_objects/project_feature_flags.rst b/docs/gl_objects/project_feature_flags.rst new file mode 100644 index 000000000..c9630f3e6 --- /dev/null +++ b/docs/gl_objects/project_feature_flags.rst @@ -0,0 +1,63 @@ +##################### +Project Feature Flags +##################### + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectFeatureFlag` + + :class:`gitlab.v4.objects.ProjectFeatureFlagManager` + + :attr:`gitlab.v4.objects.Project.feature_flags` + +* GitLab API: https://docs.gitlab.com/api/feature_flags + +Examples +-------- + +List feature flags:: + + flags = project.feature_flags.list() + +Get a feature flag:: + + flag = project.feature_flags.get('my_feature_flag') + +Create a feature flag:: + + flag = project.feature_flags.create({'name': 'my_feature_flag', 'version': 'new_version_flag'}) + +Create a feature flag with strategies:: + + flag = project.feature_flags.create({ + 'name': 'my_complex_flag', + 'version': 'new_version_flag', + 'strategies': [{ + 'name': 'userWithId', + 'parameters': {'userIds': 'user1,user2'} + }] + }) + +Update a feature flag:: + + flag.description = 'Updated description' + flag.save() + +Rename a feature flag:: + + # You can rename a flag by changing its name attribute and calling save() + flag.name = 'new_flag_name' + flag.save() + + # Alternatively, you can use the manager's update method + project.feature_flags.update('old_flag_name', {'name': 'new_flag_name'}) + +Delete a feature flag:: + + flag.delete() + +See also +-------- + +* :doc:`project_feature_flag_user_lists` diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 335bf0603..824914cef 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.ProjectManager` + :attr:`gitlab.Gitlab.projects` -* GitLab API: https://docs.gitlab.com/ce/api/projects.html +* GitLab API: https://docs.gitlab.com/api/projects Examples -------- @@ -109,6 +109,11 @@ Set the avatar image for a project:: project.avatar = open('path/to/file.png', 'rb') project.save() +Remove the avatar image for a project:: + + project.avatar = "" + project.save() + Delete a project:: gl.projects.delete(project_id) @@ -190,7 +195,7 @@ Get the repository archive:: .. note:: For the formats available, refer to - https://docs.gitlab.com/ce/api/repositories.html#get-file-archive + https://docs.gitlab.com/api/repositories#get-file-archive .. warning:: @@ -265,7 +270,7 @@ Reference + :attr:`gitlab.v4.objects.Project.imports` + :attr:`gitlab.v4.objects.ProjectManager.import_project` -* GitLab API: https://docs.gitlab.com/ce/api/project_import_export.html +* GitLab API: https://docs.gitlab.com/api/project_import_export .. _project_import_export: @@ -376,7 +381,7 @@ Reference + :class:`gitlab.v4.objects.ProjectCustomAttributeManager` + :attr:`gitlab.v4.objects.Project.customattributes` -* GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html +* GitLab API: https://docs.gitlab.com/api/custom_attributes Examples -------- @@ -404,6 +409,44 @@ Search projects by custom attribute:: project.customattributes.set('type', 'internal') gl.projects.list(custom_attributes={'type': 'internal'}, get_all=True) +Project feature flags +===================== + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectFeatureFlag` + + :class:`gitlab.v4.objects.ProjectFeatureFlagManager` + + :attr:`gitlab.v4.objects.Project.feature_flags` + +* GitLab API: https://docs.gitlab.com/api/feature_flags + +Examples +-------- + +See :doc:`project_feature_flags`. + +Project feature flag user lists +=============================== + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectFeatureFlagUserList` + + :class:`gitlab.v4.objects.ProjectFeatureFlagUserListManager` + + :attr:`gitlab.v4.objects.Project.feature_flags_user_lists` + +* GitLab API: https://docs.gitlab.com/api/feature_flag_user_lists + +Examples +-------- + +See :doc:`project_feature_flag_user_lists`. + Project files ============= @@ -416,7 +459,7 @@ Reference + :class:`gitlab.v4.objects.ProjectFileManager` + :attr:`gitlab.v4.objects.Project.files` -* GitLab API: https://docs.gitlab.com/ce/api/repository_files.html +* GitLab API: https://docs.gitlab.com/api/repository_files Examples -------- @@ -437,7 +480,7 @@ Get file details from headers, without fetching its entire content:: # Get the file size: # For a full list of headers returned, see upstream documentation. - # https://docs.gitlab.com/ee/api/repository_files.html#get-file-from-repository + # https://docs.gitlab.com/api/repository_files#get-file-from-repository print(headers["X-Gitlab-Size"]) Get a raw file:: @@ -490,7 +533,7 @@ Reference + :class:`gitlab.v4.objects.ProjectTagManager` + :attr:`gitlab.v4.objects.Project.tags` -* GitLab API: https://docs.gitlab.com/ce/api/tags.html +* GitLab API: https://docs.gitlab.com/api/tags Examples -------- @@ -533,7 +576,7 @@ Reference + :class:`gitlab.v4.objects.ProjectSnippetManager` + :attr:`gitlab.v4.objects.Project.files` -* GitLab API: https://docs.gitlab.com/ce/api/project_snippets.html +* GitLab API: https://docs.gitlab.com/api/project_snippets Examples -------- @@ -599,7 +642,7 @@ Reference + :attr:`gitlab.v4.objects.Project.members` + :attr:`gitlab.v4.objects.Project.members_all` -* GitLab API: https://docs.gitlab.com/ce/api/members.html +* GitLab API: https://docs.gitlab.com/api/members Examples -------- @@ -659,7 +702,7 @@ Reference + :class:`gitlab.v4.objects.ProjectHookManager` + :attr:`gitlab.v4.objects.Project.hooks` -* GitLab API: https://docs.gitlab.com/ce/api/projects.html#hooks +* GitLab API: https://docs.gitlab.com/api/projects#hooks Examples -------- @@ -703,7 +746,7 @@ Reference + :class:`gitlab.v4.objects.ProjectIntegrationManager` + :attr:`gitlab.v4.objects.Project.integrations` -* GitLab API: https://docs.gitlab.com/ce/api/integrations.html +* GitLab API: https://docs.gitlab.com/api/integrations Examples --------- @@ -752,7 +795,7 @@ Reference + :attr:`gitlab.v4.objects.Project.upload` -* Gitlab API: https://docs.gitlab.com/ce/api/projects.html#upload-a-file +* Gitlab API: https://docs.gitlab.com/api/projects#upload-a-file Examples -------- @@ -795,7 +838,7 @@ Reference + :class:`gitlab.v4.objects.ProjectPushRulesManager` + :attr:`gitlab.v4.objects.Project.pushrules` -* GitLab API: https://docs.gitlab.com/ee/api/projects.html#push-rules +* GitLab API: https://docs.gitlab.com/api/projects#push-rules Examples --------- @@ -829,7 +872,7 @@ Reference + :class:`gitlab.v4.objects.ProjectProtectedTagManager` + :attr:`gitlab.v4.objects.Project.protectedtags` -* GitLab API: https://docs.gitlab.com/ce/api/protected_tags.html +* GitLab API: https://docs.gitlab.com/api/protected_tags Examples --------- @@ -862,7 +905,7 @@ Reference + :class:`gitlab.v4.objects.ProjectAdditionalStatisticsManager` + :attr:`gitlab.v4.objects.Project.additionalstatistics` -* GitLab API: https://docs.gitlab.com/ce/api/project_statistics.html +* GitLab API: https://docs.gitlab.com/api/project_statistics Examples --------- @@ -889,7 +932,7 @@ Reference + :class:`gitlab.v4.objects.ProjectStorageManager` + :attr:`gitlab.v4.objects.Project.storage` -* GitLab API: https://docs.gitlab.com/ee/api/projects.html#get-the-path-to-repository-storage +* GitLab API: https://docs.gitlab.com/api/projects#get-the-path-to-repository-storage Examples --------- diff --git a/docs/gl_objects/protected_branches.rst b/docs/gl_objects/protected_branches.rst index 2a8ccf7d9..a1b1ef5c5 100644 --- a/docs/gl_objects/protected_branches.rst +++ b/docs/gl_objects/protected_branches.rst @@ -2,8 +2,8 @@ Protected branches ################## -You can define a list of protected branch names on a repository. Names can use -wildcards (``*``). +You can define a list of protected branch names on a repository or group. +Names can use wildcards (``*``). References ---------- @@ -13,19 +13,24 @@ References + :class:`gitlab.v4.objects.ProjectProtectedBranch` + :class:`gitlab.v4.objects.ProjectProtectedBranchManager` + :attr:`gitlab.v4.objects.Project.protectedbranches` + + :class:`gitlab.v4.objects.GroupProtectedBranch` + + :class:`gitlab.v4.objects.GroupProtectedBranchManager` + + :attr:`gitlab.v4.objects.Group.protectedbranches` -* GitLab API: https://docs.gitlab.com/ce/api/protected_branches.html#protected-branches-api +* GitLab API: https://docs.gitlab.com/api/protected_branches#protected-branches-api Examples -------- -Get the list of protected branches for a project:: +Get the list of protected branches for a project or group:: - p_branches = project.protectedbranches.list(get_all=True) + p_branches = project.protectedbranches.list() + p_branches = group.protectedbranches.list() Get a single protected branch:: p_branch = project.protectedbranches.get('main') + p_branch = group.protectedbranches.get('main') Update a protected branch:: diff --git a/docs/gl_objects/protected_container_repositories.rst b/docs/gl_objects/protected_container_repositories.rst index ea0d24511..bc37c6138 100644 --- a/docs/gl_objects/protected_container_repositories.rst +++ b/docs/gl_objects/protected_container_repositories.rst @@ -13,7 +13,7 @@ References + :class:`gitlab.v4.objects.ProjectRegistryRepositoryProtectionRuleRuleManager` + :attr:`gitlab.v4.objects.Project.registry_protection_repository_rules` -* GitLab API: https://docs.gitlab.com/ee/api/container_repository_protection_rules.html +* GitLab API: https://docs.gitlab.com/api/container_repository_protection_rules Examples -------- diff --git a/docs/gl_objects/protected_environments.rst b/docs/gl_objects/protected_environments.rst index 1a81a5de8..e36c1fad0 100644 --- a/docs/gl_objects/protected_environments.rst +++ b/docs/gl_objects/protected_environments.rst @@ -13,7 +13,7 @@ References + :class:`gitlab.v4.objects.ProjectProtectedEnvironmentManager` + :attr:`gitlab.v4.objects.Project.protected_environment` -* GitLab API: https://docs.gitlab.com/ee/api/protected_environments.html +* GitLab API: https://docs.gitlab.com/api/protected_environments Examples -------- diff --git a/docs/gl_objects/protected_packages.rst b/docs/gl_objects/protected_packages.rst index 108a91fd9..6865b6992 100644 --- a/docs/gl_objects/protected_packages.rst +++ b/docs/gl_objects/protected_packages.rst @@ -13,7 +13,7 @@ References + :class:`gitlab.v4.objects.ProjectPackageProtectionRuleManager` + :attr:`gitlab.v4.objects.Project.package_protection_rules` -* GitLab API: https://docs.gitlab.com/ee/api/project_packages_protection_rules.html +* GitLab API: https://docs.gitlab.com/api/project_packages_protection_rules Examples -------- diff --git a/docs/gl_objects/pull_mirror.rst b/docs/gl_objects/pull_mirror.rst index e62cd6a4e..19e8a1946 100644 --- a/docs/gl_objects/pull_mirror.rst +++ b/docs/gl_objects/pull_mirror.rst @@ -13,7 +13,7 @@ References + :class:`gitlab.v4.objects.ProjectPullMirrorManager` + :attr:`gitlab.v4.objects.Project.pull_mirror` -* GitLab API: https://docs.gitlab.com/ce/api/pull_mirror.html +* GitLab API: https://docs.gitlab.com/api/project_pull_mirroring/ Examples -------- @@ -33,6 +33,6 @@ Update an existing remote mirror's attributes:: mirror.only_protected_branches = True mirror.save() -Start an sync of the pull mirror:: +Start a sync of the pull mirror:: - mirror.start() + project.pull_mirror.start() diff --git a/docs/gl_objects/releases.rst b/docs/gl_objects/releases.rst index 662966067..99be7ce9f 100644 --- a/docs/gl_objects/releases.rst +++ b/docs/gl_objects/releases.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.ProjectReleaseManager` + :attr:`gitlab.v4.objects.Project.releases` -* Gitlab API: https://docs.gitlab.com/ee/api/releases/index.html +* Gitlab API: https://docs.gitlab.com/api/releases/index Examples -------- @@ -66,7 +66,7 @@ Reference + :class:`gitlab.v4.objects.ProjectReleaseLinkManager` + :attr:`gitlab.v4.objects.ProjectRelease.links` -* Gitlab API: https://docs.gitlab.com/ee/api/releases/links.html +* Gitlab API: https://docs.gitlab.com/api/releases/links Examples -------- diff --git a/docs/gl_objects/remote_mirrors.rst b/docs/gl_objects/remote_mirrors.rst index 505131aed..c672ca5bb 100644 --- a/docs/gl_objects/remote_mirrors.rst +++ b/docs/gl_objects/remote_mirrors.rst @@ -13,7 +13,7 @@ References + :class:`gitlab.v4.objects.ProjectRemoteMirrorManager` + :attr:`gitlab.v4.objects.Project.remote_mirrors` -* GitLab API: https://docs.gitlab.com/ce/api/remote_mirrors.html +* GitLab API: https://docs.gitlab.com/api/remote_mirrors Examples -------- @@ -36,3 +36,7 @@ Update an existing remote mirror's attributes:: Delete an existing remote mirror:: mirror.delete() + +Force push mirror update:: + + mirror.sync() diff --git a/docs/gl_objects/repositories.rst b/docs/gl_objects/repositories.rst index 6541228b4..b0c049bd2 100644 --- a/docs/gl_objects/repositories.rst +++ b/docs/gl_objects/repositories.rst @@ -11,7 +11,7 @@ References + :class:`gitlab.v4.objects.ProjectRegistryRepositoryManager` + :attr:`gitlab.v4.objects.Project.repositories` -* Gitlab API: https://docs.gitlab.com/ce/api/container_registry.html +* Gitlab API: https://docs.gitlab.com/api/container_registry Examples -------- diff --git a/docs/gl_objects/repository_tags.rst b/docs/gl_objects/repository_tags.rst index 8e71eeb91..a8e4be33f 100644 --- a/docs/gl_objects/repository_tags.rst +++ b/docs/gl_objects/repository_tags.rst @@ -11,7 +11,7 @@ References + :class:`gitlab.v4.objects.ProjectRegistryTagManager` + :attr:`gitlab.v4.objects.Repository.tags` -* Gitlab API: https://docs.gitlab.com/ce/api/container_registry.html +* Gitlab API: https://docs.gitlab.com/api/container_registry Examples -------- @@ -44,4 +44,4 @@ Delete tag in bulk:: .. note:: Delete in bulk is asynchronous operation and may take a while. - Refer to: https://docs.gitlab.com/ce/api/container_registry.html#delete-repository-tags-in-bulk + Refer to: https://docs.gitlab.com/api/container_registry#delete-repository-tags-in-bulk diff --git a/docs/gl_objects/resource_groups.rst b/docs/gl_objects/resource_groups.rst index 89d8998ac..4b1a9693f 100644 --- a/docs/gl_objects/resource_groups.rst +++ b/docs/gl_objects/resource_groups.rst @@ -14,7 +14,7 @@ Reference + :class:`gitlab.v4.objects.ProjectResourceGroupUpcomingJobManager` + :attr:`gitlab.v4.objects.ProjectResourceGroup.upcoming_jobs` -* Gitlab API: https://docs.gitlab.com/ee/api/resource_groups.html +* Gitlab API: https://docs.gitlab.com/api/resource_groups Examples -------- diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst index eda71e557..4d0686a4c 100644 --- a/docs/gl_objects/runners.rst +++ b/docs/gl_objects/runners.rst @@ -23,7 +23,7 @@ Reference + :class:`gitlab.v4.objects.RunnerAllManager` + :attr:`gitlab.Gitlab.runners_all` -* GitLab API: https://docs.gitlab.com/ce/api/runners.html +* GitLab API: https://docs.gitlab.com/api/runners Examples -------- @@ -119,7 +119,7 @@ Reference + :class:`gitlab.v4.objects.GroupRunnerManager` + :attr:`gitlab.v4.objects.Group.runners` -* GitLab API: https://docs.gitlab.com/ce/api/runners.html +* GitLab API: https://docs.gitlab.com/api/runners Examples -------- @@ -148,7 +148,7 @@ Reference + :class:`gitlab.v4.objects.RunnerJobManager` + :attr:`gitlab.v4.objects.Runner.jobs` -* GitLab API: https://docs.gitlab.com/ce/api/runners.html +* GitLab API: https://docs.gitlab.com/api/runners Examples -------- diff --git a/docs/gl_objects/search.rst b/docs/gl_objects/search.rst index 2720dc445..78ec83785 100644 --- a/docs/gl_objects/search.rst +++ b/docs/gl_objects/search.rst @@ -38,7 +38,7 @@ Reference + :attr:`gitlab.v4.objects.Group.search` + :attr:`gitlab.v4.objects.Project.search` -* GitLab API: https://docs.gitlab.com/ce/api/search.html +* GitLab API: https://docs.gitlab.com/api/search Examples -------- diff --git a/docs/gl_objects/secure_files.rst b/docs/gl_objects/secure_files.rst index 56f525a18..62d6c4b12 100644 --- a/docs/gl_objects/secure_files.rst +++ b/docs/gl_objects/secure_files.rst @@ -14,7 +14,7 @@ References + :class:`gitlab.v4.objects.ProjectSecureFileManager` + :attr:`gitlab.v4.objects.Project.secure_files` -* GitLab API: https://docs.gitlab.com/ee/api/secure_files.html +* GitLab API: https://docs.gitlab.com/api/secure_files Examples -------- diff --git a/docs/gl_objects/settings.rst b/docs/gl_objects/settings.rst index 4accfe0f0..a0ab7f012 100644 --- a/docs/gl_objects/settings.rst +++ b/docs/gl_objects/settings.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ApplicationSettingsManager` + :attr:`gitlab.Gitlab.settings` -* GitLab API: https://docs.gitlab.com/ce/api/settings.html +* GitLab API: https://docs.gitlab.com/api/settings Examples -------- diff --git a/docs/gl_objects/sidekiq.rst b/docs/gl_objects/sidekiq.rst index 5f44762e2..870de8745 100644 --- a/docs/gl_objects/sidekiq.rst +++ b/docs/gl_objects/sidekiq.rst @@ -10,7 +10,7 @@ Reference + :class:`gitlab.v4.objects.SidekiqManager` + :attr:`gitlab.Gitlab.sidekiq` -* GitLab API: https://docs.gitlab.com/ce/api/sidekiq_metrics.html +* GitLab API: https://docs.gitlab.com/api/sidekiq_metrics Examples -------- diff --git a/docs/gl_objects/snippets.rst b/docs/gl_objects/snippets.rst index 63cfd4feb..3633ec142 100644 --- a/docs/gl_objects/snippets.rst +++ b/docs/gl_objects/snippets.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.SnipptManager` + :attr:`gitlab.Gitlab.snippets` -* GitLab API: https://docs.gitlab.com/ce/api/snippets.html +* GitLab API: https://docs.gitlab.com/api/snippets Examples ======== diff --git a/docs/gl_objects/statistics.rst b/docs/gl_objects/statistics.rst index d1d72eb9e..fd49372bb 100644 --- a/docs/gl_objects/statistics.rst +++ b/docs/gl_objects/statistics.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.ApplicationStatisticsManager` + :attr:`gitlab.Gitlab.statistics` -* GitLab API: https://docs.gitlab.com/ee/api/statistics.html +* GitLab API: https://docs.gitlab.com/api/statistics Examples -------- diff --git a/docs/gl_objects/status_checks.rst b/docs/gl_objects/status_checks.rst index 9ac90db85..062231216 100644 --- a/docs/gl_objects/status_checks.rst +++ b/docs/gl_objects/status_checks.rst @@ -17,7 +17,7 @@ Reference + :class:`gitlab.v4.objects.ProjectExternalStatusCheckManager` + :attr:`gitlab.v4.objects.Project.external_status_checks` -* GitLab API: https://docs.gitlab.com/ee/api/status_checks.html +* GitLab API: https://docs.gitlab.com/api/status_checks Examples --------- diff --git a/docs/gl_objects/system_hooks.rst b/docs/gl_objects/system_hooks.rst index 088338004..7acba56a3 100644 --- a/docs/gl_objects/system_hooks.rst +++ b/docs/gl_objects/system_hooks.rst @@ -11,7 +11,7 @@ Reference + :class:`gitlab.v4.objects.HookManager` + :attr:`gitlab.Gitlab.hooks` -* GitLab API: https://docs.gitlab.com/ce/api/system_hooks.html +* GitLab API: https://docs.gitlab.com/api/system_hooks Examples -------- diff --git a/docs/gl_objects/templates.rst b/docs/gl_objects/templates.rst index b4a731b4b..6a03a7d1a 100644 --- a/docs/gl_objects/templates.rst +++ b/docs/gl_objects/templates.rst @@ -21,7 +21,7 @@ Reference + :class:`gitlab.v4.objects.LicenseManager` + :attr:`gitlab.Gitlab.licenses` -* GitLab API: https://docs.gitlab.com/ce/api/templates/licenses.html +* GitLab API: https://docs.gitlab.com/api/templates/licenses Examples -------- @@ -47,7 +47,7 @@ Reference + :class:`gitlab.v4.objects.GitignoreManager` + :attr:`gitlab.Gitlab.gitignores` -* GitLab API: https://docs.gitlab.com/ce/api/templates/gitignores.html +* GitLab API: https://docs.gitlab.com/api/templates/gitignores Examples -------- @@ -73,7 +73,7 @@ Reference + :class:`gitlab.v4.objects.GitlabciymlManager` + :attr:`gitlab.Gitlab.gitlabciymls` -* GitLab API: https://docs.gitlab.com/ce/api/templates/gitlab_ci_ymls.html +* GitLab API: https://docs.gitlab.com/api/templates/gitlab_ci_ymls Examples -------- @@ -99,7 +99,7 @@ Reference + :class:`gitlab.v4.objects.DockerfileManager` + :attr:`gitlab.Gitlab.gitlabciymls` -* GitLab API: https://docs.gitlab.com/ce/api/templates/dockerfiles.html +* GitLab API: https://docs.gitlab.com/api/templates/dockerfiles Examples -------- @@ -143,7 +143,7 @@ Reference + :class:`gitlab.v4.objects.ProjectMergeRequestTemplateManager` + :attr:`gitlab.v4.objects.Project.merge_request_templates` -* GitLab API: https://docs.gitlab.com/ce/api/project_templates.html +* GitLab API: https://docs.gitlab.com/api/project_templates Examples -------- diff --git a/docs/gl_objects/todos.rst b/docs/gl_objects/todos.rst index 88c80030b..821c60636 100644 --- a/docs/gl_objects/todos.rst +++ b/docs/gl_objects/todos.rst @@ -11,7 +11,7 @@ Reference + :class:`~gitlab.objects.TodoManager` + :attr:`gitlab.Gitlab.todos` -* GitLab API: https://docs.gitlab.com/ce/api/todos.html +* GitLab API: https://docs.gitlab.com/api/todos Examples -------- diff --git a/docs/gl_objects/topics.rst b/docs/gl_objects/topics.rst index d34c0ecac..35e12d838 100644 --- a/docs/gl_objects/topics.rst +++ b/docs/gl_objects/topics.rst @@ -13,7 +13,7 @@ Reference + :class:`gitlab.v4.objects.TopicManager` + :attr:`gitlab.Gitlab.topics` -* GitLab API: https://docs.gitlab.com/ce/api/topics.html +* GitLab API: https://docs.gitlab.com/api/topics This endpoint requires admin access for creating, updating and deleting objects. @@ -50,3 +50,16 @@ Delete a topic:: Merge a source topic into a target topic:: gl.topics.merge(topic_id, target_topic_id) + +Set the avatar image for a topic:: + + # the avatar image can be passed as data (content of the file) or as a file + # object opened in binary mode + topic.avatar = open('path/to/file.png', 'rb') + topic.save() + +Remove the avatar image for a topic:: + + topic.avatar = "" + topic.save() + diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst index e855fd29c..5ebfa296b 100644 --- a/docs/gl_objects/users.rst +++ b/docs/gl_objects/users.rst @@ -23,8 +23,8 @@ References * GitLab API: - + https://docs.gitlab.com/ee/api/users.html - + https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user + + https://docs.gitlab.com/api/users + + https://docs.gitlab.com/api/projects#list-projects-starred-by-a-user Examples -------- @@ -107,6 +107,10 @@ Get the followings of a user:: user.following_users.list(get_all=True) +List a user's contributed projects:: + + user.contributed_projects.list(get_all=True) + List a user's starred projects:: user.starred_projects.list(get_all=True) @@ -130,7 +134,7 @@ References + :class:`gitlab.v4.objects.UserCustomAttributeManager` + :attr:`gitlab.v4.objects.User.customattributes` -* GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html +* GitLab API: https://docs.gitlab.com/api/custom_attributes Examples -------- @@ -170,7 +174,7 @@ References + :class:`gitlab.v4.objects.UserImpersonationTokenManager` + :attr:`gitlab.v4.objects.User.impersonationtokens` -* GitLab API: https://docs.gitlab.com/ee/api/user_tokens.html#get-all-impersonation-tokens-of-a-user +* GitLab API: https://docs.gitlab.com/api/user_tokens#get-all-impersonation-tokens-of-a-user List impersonation tokens for a user:: @@ -204,7 +208,7 @@ References + :class:`gitlab.v4.objects.UserProjectManager` + :attr:`gitlab.v4.objects.User.projects` -* GitLab API: https://docs.gitlab.com/ee/api/projects.html#list-a-users-projects +* GitLab API: https://docs.gitlab.com/api/projects#list-a-users-projects List visible projects in the user's namespace:: @@ -229,7 +233,7 @@ References + :class:`gitlab.v4.objects.UserMembershipManager` + :attr:`gitlab.v4.objects.User.memberships` -* GitLab API: https://docs.gitlab.com/ee/api/users.html#list-projects-and-groups-that-a-user-is-a-member-of +* GitLab API: https://docs.gitlab.com/api/users#list-projects-and-groups-that-a-user-is-a-member-of List direct memberships for a user:: @@ -259,7 +263,7 @@ References + :class:`gitlab.v4.objects.CurrentUserManager` + :attr:`gitlab.Gitlab.user` -* GitLab API: https://docs.gitlab.com/ee/api/users.html +* GitLab API: https://docs.gitlab.com/api/users Examples -------- @@ -287,7 +291,7 @@ are admin. + :class:`gitlab.v4.objects.UserGPGKeyManager` + :attr:`gitlab.v4.objects.User.gpgkeys` -* GitLab API: https://docs.gitlab.com/ee/api/user_keys.html#list-your-gpg-keys +* GitLab API: https://docs.gitlab.com/api/user_keys#list-your-gpg-keys Examples -------- @@ -329,7 +333,7 @@ are admin. + :class:`gitlab.v4.objects.UserKeyManager` + :attr:`gitlab.v4.objects.User.keys` -* GitLab API: https://docs.gitlab.com/ee/api/user_keys.html#get-a-single-ssh-key +* GitLab API: https://docs.gitlab.com/api/user_keys#get-a-single-ssh-key Examples -------- @@ -370,7 +374,7 @@ You can manipulate the status for the current user and you can read the status o + :class:`gitlab.v4.objects.UserStatusManager` + :attr:`gitlab.v4.objects.User.status` -* GitLab API: https://docs.gitlab.com/ee/api/users.html#get-the-status-of-a-user +* GitLab API: https://docs.gitlab.com/api/users#get-the-status-of-a-user Examples -------- @@ -408,7 +412,7 @@ are admin. + :class:`gitlab.v4.objects.UserEmailManager` + :attr:`gitlab.v4.objects.User.emails` -* GitLab API: https://docs.gitlab.com/ee/api/user_email_addresses.html +* GitLab API: https://docs.gitlab.com/api/user_email_addresses Examples -------- @@ -445,7 +449,7 @@ References + :class:`gitlab.v4.objects.UserActivitiesManager` + :attr:`gitlab.Gitlab.user_activities` -* GitLab API: https://docs.gitlab.com/ee/api/users.html#list-a-users-activity +* GitLab API: https://docs.gitlab.com/api/users#list-a-users-activity Examples -------- @@ -463,7 +467,7 @@ Create new runner References ---------- -* New runner registration API endpoint (see `Migrating to the new runner registration workflow `_) +* New runner registration API endpoint (see `Migrating to the new runner registration workflow `_) * v4 API: @@ -471,7 +475,7 @@ References + :class:`gitlab.v4.objects.CurrentUserRunnerManager` + :attr:`gitlab.Gitlab.user.runners` -* GitLab API : https://docs.gitlab.com/ee/api/users.html#create-a-runner-linked-to-a-user +* GitLab API : https://docs.gitlab.com/api/users#create-a-runner-linked-to-a-user Examples -------- diff --git a/docs/gl_objects/variables.rst b/docs/gl_objects/variables.rst index ef28a8bea..4fd3255a2 100644 --- a/docs/gl_objects/variables.rst +++ b/docs/gl_objects/variables.rst @@ -10,7 +10,7 @@ variables to projects and groups, to modify pipeline/job scripts behavior. Please always follow GitLab's `rules for CI/CD variables`_, especially for values in masked variables. If you do not, your variables may silently fail to save. -.. _rules for CI/CD variables: https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project +.. _rules for CI/CD variables: https://docs.gitlab.com/ci/variables/#add-a-cicd-variable-to-a-project Instance-level variables ======================== @@ -28,7 +28,7 @@ Reference * GitLab API - + https://docs.gitlab.com/ce/api/instance_level_ci_variables.html + + https://docs.gitlab.com/api/instance_level_ci_variables Examples -------- @@ -73,9 +73,9 @@ Reference * GitLab API - + https://docs.gitlab.com/ce/api/instance_level_ci_variables.html - + https://docs.gitlab.com/ce/api/project_level_variables.html - + https://docs.gitlab.com/ce/api/group_level_variables.html + + https://docs.gitlab.com/api/instance_level_ci_variables + + https://docs.gitlab.com/api/project_level_variables + + https://docs.gitlab.com/api/group_level_variables Examples -------- diff --git a/docs/gl_objects/wikis.rst b/docs/gl_objects/wikis.rst index 955132b24..d9b747eb5 100644 --- a/docs/gl_objects/wikis.rst +++ b/docs/gl_objects/wikis.rst @@ -15,8 +15,8 @@ References + :class:`gitlab.v4.objects.GroupWikiManager` + :attr:`gitlab.v4.objects.Group.wikis` -* GitLab API for Projects: https://docs.gitlab.com/ce/api/wikis.html -* GitLab API for Groups: https://docs.gitlab.com/ee/api/group_wikis.html +* GitLab API for Projects: https://docs.gitlab.com/api/wikis +* GitLab API for Groups: https://docs.gitlab.com/api/group_wikis Examples -------- @@ -68,8 +68,8 @@ Reference + :attr:`gitlab.v4.objects.GrouptWiki.upload` -* Gitlab API for Projects: https://docs.gitlab.com/ee/api/wikis.html#upload-an-attachment-to-the-wiki-repository -* Gitlab API for Groups: https://docs.gitlab.com/ee/api/group_wikis.html#upload-an-attachment-to-the-wiki-repository +* Gitlab API for Projects: https://docs.gitlab.com/api/wikis#upload-an-attachment-to-the-wiki-repository +* Gitlab API for Groups: https://docs.gitlab.com/api/group_wikis#upload-an-attachment-to-the-wiki-repository Examples -------- diff --git a/gitlab/_version.py b/gitlab/_version.py index 695245ebb..82b2161e7 100644 --- a/gitlab/_version.py +++ b/gitlab/_version.py @@ -3,4 +3,4 @@ __email__ = "gauvainpocentek@gmail.com" __license__ = "LGPL3" __title__ = "python-gitlab" -__version__ = "5.6.0" +__version__ = "8.2.0" diff --git a/gitlab/cli.py b/gitlab/cli.py index a3ff5b5b4..c804911a1 100644 --- a/gitlab/cli.py +++ b/gitlab/cli.py @@ -107,7 +107,7 @@ def gitlab_resource_to_cls( return class_type -def cls_to_gitlab_resource(cls: RESTObject) -> str: +def cls_to_gitlab_resource(cls: type[RESTObject]) -> str: dasherized_uppercase = camel_upperlower_regex.sub(r"\1-\2", cls.__name__) dasherized_lowercase = camel_lowerupper_regex.sub(r"\1-\2", dasherized_uppercase) return dasherized_lowercase.lower() @@ -334,7 +334,7 @@ def main() -> None: # This first parsing step is used to find the gitlab config to use, and # load the propermodule (v3 or v4) accordingly. At that point we don't have # any subparser setup - (options, _) = parser.parse_known_args(sys.argv) + options, _ = parser.parse_known_args(sys.argv) try: config = gitlab.config.GitlabConfigParser(options.gitlab, options.config_file) except gitlab.config.ConfigError as e: diff --git a/gitlab/client.py b/gitlab/client.py index b1738210e..a3cf1f31a 100644 --- a/gitlab/client.py +++ b/gitlab/client.py @@ -18,7 +18,6 @@ try: import gql import gql.transport.exceptions - import graphql import httpx from ._backends.graphql import GitlabAsyncTransport, GitlabTransport @@ -166,6 +165,8 @@ def __init__( """See :class:`~gitlab.v4.objects.LicenseManager`""" self.namespaces = objects.NamespaceManager(self) """See :class:`~gitlab.v4.objects.NamespaceManager`""" + self.member_roles = objects.MemberRoleManager(self) + """See :class:`~gitlab.v4.objects.MergeRequestManager`""" self.mergerequests = objects.MergeRequestManager(self) """See :class:`~gitlab.v4.objects.MergeRequestManager`""" self.notificationsettings = objects.NotificationSettingsManager(self) @@ -1348,7 +1349,7 @@ def __enter__(self) -> GraphQL: def __exit__(self, *args: Any) -> None: self._http_client.close() - def execute(self, request: str | graphql.Source, *args: Any, **kwargs: Any) -> Any: + def execute(self, request: str, *args: Any, **kwargs: Any) -> Any: parsed_document = self._gql(request) retry = utils.Retry( max_retries=self._max_retries, @@ -1418,9 +1419,7 @@ async def __aenter__(self) -> AsyncGraphQL: async def __aexit__(self, *args: Any) -> None: await self._http_client.aclose() - async def execute( - self, request: str | graphql.Source, *args: Any, **kwargs: Any - ) -> Any: + async def execute(self, request: str, *args: Any, **kwargs: Any) -> Any: parsed_document = self._gql(request) retry = utils.Retry( max_retries=self._max_retries, diff --git a/gitlab/const.py b/gitlab/const.py index 9e0b766ea..7a0492e64 100644 --- a/gitlab/const.py +++ b/gitlab/const.py @@ -93,6 +93,7 @@ class PipelineStatus(GitlabEnum): NO_ACCESS = AccessLevel.NO_ACCESS.value MINIMAL_ACCESS = AccessLevel.MINIMAL_ACCESS.value GUEST_ACCESS = AccessLevel.GUEST.value +PLANNER_ACCESS = AccessLevel.PLANNER.value REPORTER_ACCESS = AccessLevel.REPORTER.value DEVELOPER_ACCESS = AccessLevel.DEVELOPER.value MAINTAINER_ACCESS = AccessLevel.MAINTAINER.value @@ -151,6 +152,7 @@ class PipelineStatus(GitlabEnum): "NOTIFICATION_LEVEL_PARTICIPATING", "NOTIFICATION_LEVEL_WATCH", "OWNER_ACCESS", + "PLANNER_ACCESS", "REPORTER_ACCESS", "SEARCH_SCOPE_BLOBS", "SEARCH_SCOPE_COMMITS", diff --git a/gitlab/mixins.py b/gitlab/mixins.py index ff99abdf6..51de97876 100644 --- a/gitlab/mixins.py +++ b/gitlab/mixins.py @@ -660,10 +660,11 @@ class ObjectRotateMixin(_RestObjectBase): optional=("expires_at",), ) @exc.on_http_error(exc.GitlabRotateError) - def rotate(self, **kwargs: Any) -> dict[str, Any]: + def rotate(self, *, self_rotate: bool = False, **kwargs: Any) -> dict[str, Any]: """Rotate the current access token object. Args: + self_rotate: If True, the current access token object will be rotated. **kwargs: Extra options to send to the server (e.g. sudo) Raises: @@ -673,7 +674,8 @@ def rotate(self, **kwargs: Any) -> dict[str, Any]: if TYPE_CHECKING: assert isinstance(self.manager, RotateMixin) assert self.encoded_id is not None - server_data = self.manager.rotate(self.encoded_id, **kwargs) + token_id = "self" if self_rotate else self.encoded_id + server_data = self.manager.rotate(token_id, **kwargs) self._update_attrs(server_data) return server_data diff --git a/gitlab/types.py b/gitlab/types.py index d0e8d3952..ae0aba707 100644 --- a/gitlab/types.py +++ b/gitlab/types.py @@ -1,8 +1,11 @@ from __future__ import annotations import dataclasses +import json from typing import Any, TYPE_CHECKING +from gitlab import exceptions + @dataclasses.dataclass(frozen=True) class RequiredOptional: @@ -36,6 +39,13 @@ def validate_attrs( class GitlabAttribute: + # Used in utils._transform_types() to decide if we should call get_for_api() + # on the attribute when transform_data is False (e.g. for POST/PUT/PATCH). + # + # This allows us to force transformation of data even when sending JSON bodies, + # which is useful for types like CommaSeparatedStringAttribute. + transform_in_body = False + def __init__(self, value: Any = None) -> None: self._value = value @@ -49,6 +59,16 @@ def get_for_api(self, *, key: str) -> tuple[str, Any]: return (key, self._value) +class JsonAttribute(GitlabAttribute): + def set_from_cli(self, cli_value: str) -> None: + try: + self._value = json.loads(cli_value) + except (ValueError, TypeError) as e: + raise exceptions.GitlabParsingError( + f"Could not parse JSON data: {e}" + ) from e + + class _ListArrayAttribute(GitlabAttribute): """Helper class to support `list` / `array` types.""" @@ -82,9 +102,23 @@ def get_for_api(self, *, key: str) -> tuple[str, Any]: class CommaSeparatedListAttribute(_ListArrayAttribute): - """For values which are sent to the server as a Comma Separated Values - (CSV) string. We allow them to be specified as a list and we convert it - into a CSV""" + """ + For values which are sent to the server as a Comma Separated Values (CSV) string + in query parameters (GET), but as a list/array in JSON bodies (POST/PUT). + """ + + +class CommaSeparatedStringAttribute(_ListArrayAttribute): + """ + For values which are sent to the server as a Comma Separated Values (CSV) string. + Unlike CommaSeparatedListAttribute, this type ensures the value is converted + to a string even in JSON bodies (POST/PUT requests). + """ + + # Used in utils._transform_types() to ensure the value is converted to a string + # via get_for_api() even when transform_data is False (e.g. for POST/PUT/PATCH). + # This is needed because some APIs require a CSV string instead of a JSON array. + transform_in_body = True class LowercaseStringAttribute(GitlabAttribute): diff --git a/gitlab/utils.py b/gitlab/utils.py index 400793e24..49a280278 100644 --- a/gitlab/utils.py +++ b/gitlab/utils.py @@ -133,7 +133,7 @@ def handle_retry_on_status( if "Retry-After" in headers: wait_time = int(headers["Retry-After"]) elif "RateLimit-Reset" in headers: - wait_time = int(headers["RateLimit-Reset"]) - time.time() + wait_time = max(0, int(headers["RateLimit-Reset"]) - time.time()) self.cur_retries += 1 time.sleep(wait_time) return True @@ -188,11 +188,25 @@ def _transform_types( # if the type is FileAttribute we need to pass the data as file if isinstance(gitlab_attribute, types.FileAttribute) and transform_files: + # The GitLab API accepts mixed types + # (e.g. a file for avatar image or empty string for removing the avatar) + # So if string is empty, keep it in data dict + if isinstance(data[attr_name], str) and data[attr_name] == "": + continue + key = gitlab_attribute.get_file_name(attr_name) files[attr_name] = (key, data.pop(attr_name)) continue - if not transform_data: + # If transform_data is False, it means we are preparing data for a JSON body + # (POST/PUT/PATCH). In this case, we normally skip transformation because + # most types (like ArrayAttribute) only need transformation for query + # parameters (GET). + # + # However, some types (like CommaSeparatedStringAttribute) need to be + # transformed even in JSON bodies (e.g. converting a list to a CSV string). + # The 'transform_in_body' flag on the attribute class controls this behavior. + if not transform_data and not gitlab_attribute.transform_in_body: continue if isinstance(gitlab_attribute, types.GitlabAttribute): diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py index 067a0a155..87fcaf261 100644 --- a/gitlab/v4/cli.py +++ b/gitlab/v4/cli.py @@ -394,7 +394,7 @@ def extend_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser: subparsers.required = True # populate argparse for all Gitlab Object - classes = set() + classes: set[type[gitlab.base.RESTObject]] = set() for cls in gitlab.v4.objects.__dict__.values(): if not isinstance(cls, type): continue diff --git a/gitlab/v4/objects/__init__.py b/gitlab/v4/objects/__init__.py index 7932080ac..460297df7 100644 --- a/gitlab/v4/objects/__init__.py +++ b/gitlab/v4/objects/__init__.py @@ -24,6 +24,8 @@ from .epics import * from .events import * from .export_import import * +from .feature_flag_user_lists import * +from .feature_flags import * from .features import * from .files import * from .geo_nodes import * @@ -39,6 +41,7 @@ from .keys import * from .labels import * from .ldap import * +from .member_roles import * from .members import * from .merge_request_approvals import * from .merge_requests import * diff --git a/gitlab/v4/objects/boards.py b/gitlab/v4/objects/boards.py index 861b09046..1683a5fe1 100644 --- a/gitlab/v4/objects/boards.py +++ b/gitlab/v4/objects/boards.py @@ -23,7 +23,7 @@ class GroupBoardListManager(CRUDMixin[GroupBoardList]): _obj_cls = GroupBoardList _from_parent_attrs = {"group_id": "group_id", "board_id": "id"} _create_attrs = RequiredOptional( - exclusive=("label_id", "assignee_id", "milestone_id") + exclusive=("label_id", "assignee_id", "milestone_id", "iteration_id") ) _update_attrs = RequiredOptional(required=("position",)) @@ -48,7 +48,7 @@ class ProjectBoardListManager(CRUDMixin[ProjectBoardList]): _obj_cls = ProjectBoardList _from_parent_attrs = {"project_id": "project_id", "board_id": "id"} _create_attrs = RequiredOptional( - exclusive=("label_id", "assignee_id", "milestone_id") + exclusive=("label_id", "assignee_id", "milestone_id", "iteration_id") ) _update_attrs = RequiredOptional(required=("position",)) diff --git a/gitlab/v4/objects/branches.py b/gitlab/v4/objects/branches.py index 0724476a6..12dbf8848 100644 --- a/gitlab/v4/objects/branches.py +++ b/gitlab/v4/objects/branches.py @@ -49,3 +49,27 @@ class ProjectProtectedBranchManager(CRUDMixin[ProjectProtectedBranch]): ), ) _update_method = UpdateMethod.PATCH + + +class GroupProtectedBranch(SaveMixin, ObjectDeleteMixin, RESTObject): + _id_attr = "name" + + +class GroupProtectedBranchManager(CRUDMixin[GroupProtectedBranch]): + _path = "/groups/{group_id}/protected_branches" + _obj_cls = GroupProtectedBranch + _from_parent_attrs = {"group_id": "id"} + _create_attrs = RequiredOptional( + required=("name",), + optional=( + "push_access_level", + "merge_access_level", + "unprotect_access_level", + "allow_force_push", + "allowed_to_push", + "allowed_to_merge", + "allowed_to_unprotect", + "code_owner_approval_required", + ), + ) + _update_method = UpdateMethod.PATCH diff --git a/gitlab/v4/objects/ci_lint.py b/gitlab/v4/objects/ci_lint.py index 01d38373d..9bbe9f7e4 100644 --- a/gitlab/v4/objects/ci_lint.py +++ b/gitlab/v4/objects/ci_lint.py @@ -51,7 +51,14 @@ class ProjectCiLintManager( _path = "/projects/{project_id}/ci/lint" _obj_cls = ProjectCiLint _from_parent_attrs = {"project_id": "id"} - _optional_get_attrs = ("dry_run", "include_jobs", "ref") + _optional_get_attrs = ( + "content_ref", + "dry_run", + "dry_run_ref", + "include_jobs", + "ref", + ) + _create_attrs = RequiredOptional( required=("content",), optional=("dry_run", "include_jobs", "ref") ) diff --git a/gitlab/v4/objects/feature_flag_user_lists.py b/gitlab/v4/objects/feature_flag_user_lists.py new file mode 100644 index 000000000..50861715a --- /dev/null +++ b/gitlab/v4/objects/feature_flag_user_lists.py @@ -0,0 +1,27 @@ +""" +GitLab API: +https://docs.gitlab.com/api/feature_flag_user_lists +""" + +from __future__ import annotations + +from gitlab import types +from gitlab.base import RESTObject +from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin +from gitlab.types import RequiredOptional + +__all__ = ["ProjectFeatureFlagUserList", "ProjectFeatureFlagUserListManager"] + + +class ProjectFeatureFlagUserList(SaveMixin, ObjectDeleteMixin, RESTObject): + _id_attr = "iid" + + +class ProjectFeatureFlagUserListManager(CRUDMixin[ProjectFeatureFlagUserList]): + _path = "/projects/{project_id}/feature_flags_user_lists" + _obj_cls = ProjectFeatureFlagUserList + _from_parent_attrs = {"project_id": "id"} + _create_attrs = RequiredOptional(required=("name", "user_xids")) + _update_attrs = RequiredOptional(optional=("name", "user_xids")) + _list_filters = ("search",) + _types = {"user_xids": types.CommaSeparatedStringAttribute} diff --git a/gitlab/v4/objects/feature_flags.py b/gitlab/v4/objects/feature_flags.py new file mode 100644 index 000000000..b34283b6c --- /dev/null +++ b/gitlab/v4/objects/feature_flags.py @@ -0,0 +1,106 @@ +""" +GitLab API: +https://docs.gitlab.com/api/feature_flags +""" + +from __future__ import annotations + +from typing import Any + +from gitlab import types, utils +from gitlab.base import RESTObject +from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin +from gitlab.types import RequiredOptional + +__all__ = ["ProjectFeatureFlag", "ProjectFeatureFlagManager"] + + +class ProjectFeatureFlag(SaveMixin, ObjectDeleteMixin, RESTObject): + _id_attr = "name" + manager: ProjectFeatureFlagManager + + def _get_save_url_id(self) -> str | int | None: + """Get the ID used to construct the API URL for the save operation. + + For renames, this must be the *original* name of the flag. For other + updates, it is the current name. + """ + if self._id_attr in self._updated_attrs: + # If the name is being changed, use the original name for the URL. + obj_id = self._attrs.get(self._id_attr) + if isinstance(obj_id, str): + return utils.EncodedId(obj_id) + return obj_id + return self.encoded_id + + def save(self, **kwargs: Any) -> dict[str, Any] | None: + """Save the changes made to the object to the server. + + This is the standard method to use when updating a feature flag object + that you have already retrieved. + + It is overridden here to correctly handle renaming. When `name` is + changed, the API requires the *original* name in the URL, and this + method provides it. + + Args: + **kwargs: Extra options to send to the server (e.g. sudo) + + Returns: + The new object data (*not* a RESTObject) + + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabUpdateError: If the server cannot perform the request + """ + updated_data = self._get_updated_data() + if not updated_data: + return None + + obj_id = self._get_save_url_id() + server_data = self.manager.update(obj_id, updated_data, **kwargs) + self._update_attrs(server_data) + return server_data + + +class ProjectFeatureFlagManager(CRUDMixin[ProjectFeatureFlag]): + _path = "/projects/{project_id}/feature_flags" + _obj_cls = ProjectFeatureFlag + _from_parent_attrs = {"project_id": "id"} + _create_attrs = RequiredOptional( + required=("name",), optional=("version", "description", "active", "strategies") + ) + _update_attrs = RequiredOptional( + # new_name is used for renaming via CLI and mapped to 'name' in update() + optional=("name", "new_name", "description", "active", "strategies") + ) + _list_filters = ("scope",) + _types = {"strategies": types.JsonAttribute} + + def update( + self, + id: str | int | None = None, + new_data: dict[str, Any] | None = None, + **kwargs: Any, + ) -> dict[str, Any]: + """Update a Project Feature Flag. + + This is a lower-level method called by `ProjectFeatureFlag.save()` and + is also used directly by the CLI. + + The `new_name` parameter is a special case to support renaming via the + CLI (`--new-name`). It is converted to the `name` parameter that the + GitLab API expects in the request body. + + Args: + id: The current name of the feature flag. + new_data: The dictionary of attributes to update. + **kwargs: Extra options to send to the server (e.g. sudo) + """ + # Avoid mutating the caller-provided new_data dict by working on a copy. + data = dict(new_data or {}) + # When used via CLI, we have 'new_name' to distinguish from the ID 'name'. + # When used via .save(), the object passes 'name' directly in new_data. + if "new_name" in data: + data["name"] = data.pop("new_name") + return super().update(id, data, **kwargs) diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py index 757d16eeb..3bcf931a2 100644 --- a/gitlab/v4/objects/files.py +++ b/gitlab/v4/objects/files.py @@ -29,6 +29,7 @@ class ProjectFile(SaveMixin, ObjectDeleteMixin, RESTObject): file_path: str manager: ProjectFileManager content: str # since the `decode()` method uses `self.content` + start_branch: str | None = None def decode(self) -> bytes: """Returns the decoded content of the file. @@ -41,7 +42,11 @@ def decode(self) -> bytes: # NOTE(jlvillal): Signature doesn't match SaveMixin.save() so ignore # type error def save( # type: ignore[override] - self, branch: str, commit_message: str, **kwargs: Any + self, + branch: str, + commit_message: str, + start_branch: str | None = None, + **kwargs: Any, ) -> None: """Save the changes made to the file to the server. @@ -50,6 +55,7 @@ def save( # type: ignore[override] Args: branch: Branch in which the file will be updated commit_message: Message to send with the commit + start_branch: Name of the branch to start the new branch from **kwargs: Extra options to send to the server (e.g. sudo) Raises: @@ -58,6 +64,7 @@ def save( # type: ignore[override] """ self.branch = branch self.commit_message = commit_message + self.start_branch = start_branch self.file_path = utils.EncodedId(self.file_path) super().save(**kwargs) diff --git a/gitlab/v4/objects/groups.py b/gitlab/v4/objects/groups.py index 58b8c9a4d..7a1767817 100644 --- a/gitlab/v4/objects/groups.py +++ b/gitlab/v4/objects/groups.py @@ -24,6 +24,7 @@ from .audit_events import GroupAuditEventManager # noqa: F401 from .badges import GroupBadgeManager # noqa: F401 from .boards import GroupBoardManager # noqa: F401 +from .branches import GroupProtectedBranchManager # noqa: F401 from .clusters import GroupClusterManager # noqa: F401 from .container_registry import GroupRegistryRepositoryManager # noqa: F401 from .custom_attributes import GroupCustomAttributeManager # noqa: F401 @@ -36,6 +37,7 @@ from .issues import GroupIssueManager # noqa: F401 from .iterations import GroupIterationManager # noqa: F401 from .labels import GroupLabelManager # noqa: F401 +from .member_roles import GroupMemberRoleManager # noqa: F401 from .members import ( # noqa: F401 GroupBillableMemberManager, GroupMemberAllManager, @@ -92,6 +94,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject): iterations: GroupIterationManager labels: GroupLabelManager ldap_group_links: GroupLDAPGroupLinkManager + member_roles: GroupMemberRoleManager members: GroupMemberManager members_all: GroupMemberAllManager mergerequests: GroupMergeRequestManager @@ -100,6 +103,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject): packages: GroupPackageManager projects: GroupProjectManager shared_projects: SharedProjectManager + protectedbranches: GroupProtectedBranchManager pushrules: GroupPushRulesManager registry_repositories: GroupRegistryRepositoryManager runners: GroupRunnerManager diff --git a/gitlab/v4/objects/jobs.py b/gitlab/v4/objects/jobs.py index 6aa6fc460..f0062c989 100644 --- a/gitlab/v4/objects/jobs.py +++ b/gitlab/v4/objects/jobs.py @@ -346,5 +346,5 @@ class ProjectJobManager(RetrieveMixin[ProjectJob]): _path = "/projects/{project_id}/jobs" _obj_cls = ProjectJob _from_parent_attrs = {"project_id": "id"} - _list_filters = ("scope",) + _list_filters = ("scope", "order_by", "sort") _types = {"scope": ArrayAttribute} diff --git a/gitlab/v4/objects/member_roles.py b/gitlab/v4/objects/member_roles.py new file mode 100644 index 000000000..73c5c6644 --- /dev/null +++ b/gitlab/v4/objects/member_roles.py @@ -0,0 +1,102 @@ +""" +GitLab API: +https://docs.gitlab.com/ee/api/instance_level_ci_variables.html +https://docs.gitlab.com/ee/api/project_level_variables.html +https://docs.gitlab.com/ee/api/group_level_variables.html +""" + +from gitlab.base import RESTObject +from gitlab.mixins import ( + CreateMixin, + DeleteMixin, + ListMixin, + ObjectDeleteMixin, + SaveMixin, +) +from gitlab.types import RequiredOptional + +__all__ = [ + "MemberRole", + "MemberRoleManager", + "GroupMemberRole", + "GroupMemberRoleManager", +] + + +class MemberRole(SaveMixin, ObjectDeleteMixin, RESTObject): + pass + + +class MemberRoleManager( + ListMixin[MemberRole], CreateMixin[MemberRole], DeleteMixin[MemberRole] +): + _path = "/member_roles" + _obj_cls = MemberRole + _create_attrs = RequiredOptional( + required=("name", "base_access_level"), + optional=( + "description", + "admin_cicd_variables", + "admin_compliance_framework", + "admin_group_member", + "admin_group_member", + "admin_merge_request", + "admin_push_rules", + "admin_terraform_state", + "admin_vulnerability", + "admin_web_hook", + "archive_project", + "manage_deploy_tokens", + "manage_group_access_tokens", + "manage_merge_request_settings", + "manage_project_access_tokens", + "manage_security_policy_link", + "read_code", + "read_runners", + "read_dependency", + "read_vulnerability", + "remove_group", + "remove_project", + ), + ) + + +class GroupMemberRole(SaveMixin, ObjectDeleteMixin, RESTObject): + pass + + +class GroupMemberRoleManager( + ListMixin[GroupMemberRole], + CreateMixin[GroupMemberRole], + DeleteMixin[GroupMemberRole], +): + _path = "/groups/{group_id}/member_roles" + _from_parent_attrs = {"group_id": "id"} + _obj_cls = GroupMemberRole + _create_attrs = RequiredOptional( + required=("name", "base_access_level"), + optional=( + "description", + "admin_cicd_variables", + "admin_compliance_framework", + "admin_group_member", + "admin_group_member", + "admin_merge_request", + "admin_push_rules", + "admin_terraform_state", + "admin_vulnerability", + "admin_web_hook", + "archive_project", + "manage_deploy_tokens", + "manage_group_access_tokens", + "manage_merge_request_settings", + "manage_project_access_tokens", + "manage_security_policy_link", + "read_code", + "read_runners", + "read_dependency", + "read_vulnerability", + "remove_group", + "remove_project", + ), + ) diff --git a/gitlab/v4/objects/merge_request_approvals.py b/gitlab/v4/objects/merge_request_approvals.py index 6ca324ecf..3d2082b91 100644 --- a/gitlab/v4/objects/merge_request_approvals.py +++ b/gitlab/v4/objects/merge_request_approvals.py @@ -90,7 +90,13 @@ class ProjectApprovalRuleManager( _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( required=("name", "approvals_required"), - optional=("user_ids", "group_ids", "protected_branch_ids", "usernames"), + optional=( + "user_ids", + "group_ids", + "protected_branch_ids", + "usernames", + "applies_to_all_protected_branches", + ), ) diff --git a/gitlab/v4/objects/notes.py b/gitlab/v4/objects/notes.py index f104c3f5d..3e83d9be1 100644 --- a/gitlab/v4/objects/notes.py +++ b/gitlab/v4/objects/notes.py @@ -128,12 +128,7 @@ class ProjectIssueDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject): pass -class ProjectIssueDiscussionNoteManager( - GetMixin[ProjectIssueDiscussionNote], - CreateMixin[ProjectIssueDiscussionNote], - UpdateMixin[ProjectIssueDiscussionNote], - DeleteMixin[ProjectIssueDiscussionNote], -): +class ProjectIssueDiscussionNoteManager(CRUDMixin[ProjectIssueDiscussionNote]): _path = ( "/projects/{project_id}/issues/{issue_iid}/discussions/{discussion_id}/notes" ) @@ -164,10 +159,7 @@ class ProjectMergeRequestDiscussionNote(SaveMixin, ObjectDeleteMixin, RESTObject class ProjectMergeRequestDiscussionNoteManager( - GetMixin[ProjectMergeRequestDiscussionNote], - CreateMixin[ProjectMergeRequestDiscussionNote], - UpdateMixin[ProjectMergeRequestDiscussionNote], - DeleteMixin[ProjectMergeRequestDiscussionNote], + CRUDMixin[ProjectMergeRequestDiscussionNote] ): _path = ( "/projects/{project_id}/merge_requests/{mr_iid}/" diff --git a/gitlab/v4/objects/packages.py b/gitlab/v4/objects/packages.py index 1a59c7ec7..99edd2f83 100644 --- a/gitlab/v4/objects/packages.py +++ b/gitlab/v4/objects/packages.py @@ -220,6 +220,9 @@ class GroupPackageManager(ListMixin[GroupPackage]): "sort", "package_type", "package_name", + "package_version", + "include_versionless", + "status", ) @@ -234,7 +237,15 @@ class ProjectPackageManager( _path = "/projects/{project_id}/packages" _obj_cls = ProjectPackage _from_parent_attrs = {"project_id": "id"} - _list_filters = ("order_by", "sort", "package_type", "package_name") + _list_filters = ( + "order_by", + "sort", + "package_type", + "package_name", + "package_version", + "include_versionless", + "status", + ) class ProjectPackageFile(ObjectDeleteMixin, RESTObject): diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py index 0eaceb5a6..22975ff9f 100644 --- a/gitlab/v4/objects/projects.py +++ b/gitlab/v4/objects/projects.py @@ -49,6 +49,8 @@ ) from .events import ProjectEventManager # noqa: F401 from .export_import import ProjectExportManager, ProjectImportManager # noqa: F401 +from .feature_flag_user_lists import ProjectFeatureFlagUserListManager # noqa: F401 +from .feature_flags import ProjectFeatureFlagManager # noqa: F401 from .files import ProjectFileManager # noqa: F401 from .hooks import ProjectHookManager # noqa: F401 from .integrations import ProjectIntegrationManager, ProjectServiceManager # noqa: F401 @@ -178,6 +180,8 @@ class Project( _repr_attr = "path_with_namespace" _upload_path = "/projects/{id}/uploads" + path_with_namespace: str + access_tokens: ProjectAccessTokenManager accessrequests: ProjectAccessRequestManager additionalstatistics: ProjectAdditionalStatisticsManager @@ -199,6 +203,8 @@ class Project( environments: ProjectEnvironmentManager events: ProjectEventManager exports: ProjectExportManager + feature_flags: ProjectFeatureFlagManager + feature_flags_user_lists: ProjectFeatureFlagUserListManager files: ProjectFileManager forks: ProjectForkManager generic_packages: GenericPackageManager @@ -429,6 +435,7 @@ def trigger_pipeline( ref: str, token: str, variables: dict[str, Any] | None = None, + inputs: dict[str, Any] | None = None, **kwargs: Any, ) -> ProjectPipeline: """Trigger a CI build. @@ -439,6 +446,7 @@ def trigger_pipeline( ref: Commit to build; can be a branch name or a tag token: The trigger token variables: Variables passed to the build script + inputs: Inputs passed to the build script **kwargs: Extra options to send to the server (e.g. sudo) Raises: @@ -446,8 +454,14 @@ def trigger_pipeline( GitlabCreateError: If the server failed to perform the request """ variables = variables or {} + inputs = inputs or {} path = f"/projects/{self.encoded_id}/trigger/pipeline" - post_data = {"ref": ref, "token": token, "variables": variables} + post_data = { + "ref": ref, + "token": token, + "variables": variables, + "inputs": inputs, + } attrs = self.manager.gitlab.http_post(path, post_data=post_data, **kwargs) if TYPE_CHECKING: assert isinstance(attrs, dict) @@ -1225,7 +1239,20 @@ def create(self, data: dict[str, Any] | None = None, **kwargs: Any) -> ProjectFo class ProjectRemoteMirror(ObjectDeleteMixin, SaveMixin, RESTObject): - pass + @cli.register_custom_action(cls_names="ProjectRemoteMirror") + @exc.on_http_error(exc.GitlabCreateError) + def sync(self, **kwargs: Any) -> dict[str, Any] | requests.Response: + """Force push mirror update. + + Args: + **kwargs: Extra options to send to the server (e.g. sudo) + + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabCreateError: If the server cannot perform the request + """ + path = f"{self.manager.path}/{self.encoded_id}/sync" + return self.manager.gitlab.http_post(path, **kwargs) class ProjectRemoteMirrorManager( diff --git a/gitlab/v4/objects/registry_protection_repository_rules.py b/gitlab/v4/objects/registry_protection_repository_rules.py index 19d4bdf59..2a457a024 100644 --- a/gitlab/v4/objects/registry_protection_repository_rules.py +++ b/gitlab/v4/objects/registry_protection_repository_rules.py @@ -1,5 +1,12 @@ from gitlab.base import RESTObject -from gitlab.mixins import CreateMixin, ListMixin, SaveMixin, UpdateMethod, UpdateMixin +from gitlab.mixins import ( + CreateMixin, + DeleteMixin, + ListMixin, + SaveMixin, + UpdateMethod, + UpdateMixin, +) from gitlab.types import RequiredOptional __all__ = [ @@ -16,6 +23,7 @@ class ProjectRegistryRepositoryProtectionRuleManager( ListMixin[ProjectRegistryRepositoryProtectionRule], CreateMixin[ProjectRegistryRepositoryProtectionRule], UpdateMixin[ProjectRegistryRepositoryProtectionRule], + DeleteMixin[ProjectRegistryRepositoryProtectionRule], ): _path = "/projects/{project_id}/registry/protection/repository/rules" _obj_cls = ProjectRegistryRepositoryProtectionRule diff --git a/gitlab/v4/objects/repositories.py b/gitlab/v4/objects/repositories.py index 71935caaa..a621cda43 100644 --- a/gitlab/v4/objects/repositories.py +++ b/gitlab/v4/objects/repositories.py @@ -17,6 +17,8 @@ if TYPE_CHECKING: # When running mypy we use these as the base classes + import gitlab.base + _RestObjectBase = gitlab.base.RESTObject else: _RestObjectBase = object diff --git a/gitlab/v4/objects/runners.py b/gitlab/v4/objects/runners.py index e4a37e8e3..ba7256cf5 100644 --- a/gitlab/v4/objects/runners.py +++ b/gitlab/v4/objects/runners.py @@ -38,7 +38,7 @@ class RunnerJobManager(ListMixin[RunnerJob]): _path = "/runners/{runner_id}/jobs" _obj_cls = RunnerJob _from_parent_attrs = {"runner_id": "id"} - _list_filters = ("status",) + _list_filters = ("status", "order_by", "sort") class Runner(SaveMixin, ObjectDeleteMixin, RESTObject): diff --git a/gitlab/v4/objects/settings.py b/gitlab/v4/objects/settings.py index 41d820647..fd8629b36 100644 --- a/gitlab/v4/objects/settings.py +++ b/gitlab/v4/objects/settings.py @@ -25,6 +25,7 @@ class ApplicationSettingsManager( "id", "default_projects_limit", "signup_enabled", + "silent_mode_enabled", "password_authentication_enabled_for_web", "gravatar_enabled", "sign_in_text", diff --git a/gitlab/v4/objects/tags.py b/gitlab/v4/objects/tags.py index 7a559daa7..ad04b4928 100644 --- a/gitlab/v4/objects/tags.py +++ b/gitlab/v4/objects/tags.py @@ -19,6 +19,7 @@ class ProjectTagManager(NoUpdateMixin[ProjectTag]): _path = "/projects/{project_id}/repository/tags" _obj_cls = ProjectTag _from_parent_attrs = {"project_id": "id"} + _list_filters = ("order_by", "sort", "search") _create_attrs = RequiredOptional( required=("tag_name", "ref"), optional=("message",) ) diff --git a/gitlab/v4/objects/users.py b/gitlab/v4/objects/users.py index 2c7c28a2c..be0e36529 100644 --- a/gitlab/v4/objects/users.py +++ b/gitlab/v4/objects/users.py @@ -68,6 +68,8 @@ "UserMembershipManager", "UserProject", "UserProjectManager", + "UserContributedProject", + "UserContributedProjectManager", ] @@ -182,6 +184,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject): memberships: UserMembershipManager personal_access_tokens: UserPersonalAccessTokenManager projects: UserProjectManager + contributed_projects: UserContributedProjectManager starred_projects: StarredProjectManager status: UserStatusManager @@ -397,16 +400,29 @@ class UserManager(CRUDMixin[User]): _obj_cls = User _list_filters = ( + "username", + "public_email", + "search", "active", + "external", "blocked", - "username", + "humans", + "created_after", + "created_before", + "exclude_active", + "exclude_external", + "exclude_humans", + "exclude_internal", + "without_project_bots", "extern_uid", "provider", - "external", - "search", + "two_factor", + "without_projects", + "admins", + "auditors", + "skip_ldap", "custom_attributes", "status", - "two_factor", ) _create_attrs = RequiredOptional( optional=( @@ -486,7 +502,9 @@ class UserEmailManager( _path = "/users/{user_id}/emails" _obj_cls = UserEmail _from_parent_attrs = {"user_id": "id"} - _create_attrs = RequiredOptional(required=("email",)) + _create_attrs = RequiredOptional( + required=("email",), optional=("skip_confirmation",) + ) class UserActivities(RESTObject): @@ -665,6 +683,17 @@ def list( return super().list(path=path, iterator=iterator, **kwargs) +class UserContributedProject(RESTObject): + _id_attr = "id" + _repr_attr = "path_with_namespace" + + +class UserContributedProjectManager(ListMixin[UserContributedProject]): + _path = "/users/{user_id}/contributed_projects" + _obj_cls = UserContributedProject + _from_parent_attrs = {"user_id": "id"} + + class StarredProject(RESTObject): pass diff --git a/pyproject.toml b/pyproject.toml index 5104c2b16..45e8c36f8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,7 +15,7 @@ maintainers = [ {name = "Nejc Habjan", email="nejc.habjan@siemens.com"}, {name = "Roger Meier", email="r.meier@siemens.com"} ] -requires-python = ">=3.9.0" +requires-python = ">=3.10.0" dependencies = [ "requests>=2.32.0", "requests-toolbelt>=1.0.0", @@ -30,11 +30,11 @@ classifiers = [ "Operating System :: Microsoft :: Windows", "Programming Language :: Python", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", ] keywords = ["api", "client", "gitlab", "python", "python-gitlab", "wrapper"] license = {text = "LGPL-3.0-or-later"} @@ -43,7 +43,7 @@ dynamic = ["version"] [project.optional-dependencies] autocompletion = ["argcomplete>=1.10.0,<3"] yaml = ["PyYaml>=6.0.1"] -graphql = ["gql[httpx]>=3.5.0,<4"] +graphql = ["gql[httpx]>=3.5.0,<5"] [project.scripts] gitlab = "gitlab.cli:main" @@ -101,6 +101,13 @@ version_variables = [ ] commit_message = "chore: release v{version}" +[tool.semantic_release.changelog] +exclude_commit_patterns = [ + '''chore\(deps\): .+''', # Exclude dependency updates from the changelog +] +mode = "update" +insertion_flag = "All versions below are listed in reverse chronological order." + [tool.pylint.messages_control] max-line-length = 88 jobs = 0 # Use auto-detected number of multiple processes to speed up Pylint. diff --git a/requirements-docker.txt b/requirements-docker.txt index 781e402ea..123a4438a 100644 --- a/requirements-docker.txt +++ b/requirements-docker.txt @@ -1,3 +1,3 @@ -r requirements.txt -r requirements-test.txt -pytest-docker==3.1.1 +pytest-docker==3.2.5 diff --git a/requirements-docs.txt b/requirements-docs.txt index b55450457..1c445092a 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,7 +1,7 @@ -r requirements.txt -furo==2024.8.6 -jinja2==3.1.5 -myst-parser==4.0.0 -sphinx==8.1.3 +furo==2025.12.19 +jinja2==3.1.6 +myst-parser==5.0.0 +sphinx==9.1.0 sphinxcontrib-autoprogram==0.1.9 -sphinx-autobuild==2024.10.3 +sphinx-autobuild==2025.8.25 diff --git a/requirements-lint.txt b/requirements-lint.txt index e4a48bd4c..05b5ca496 100644 --- a/requirements-lint.txt +++ b/requirements-lint.txt @@ -1,14 +1,14 @@ -r requirements.txt argcomplete==2.0.0 -black==25.1.0 -commitizen==4.1.1 -flake8==7.1.1 -isort==6.0.0 -mypy==1.14.1 -pylint==3.3.4 -pytest==8.3.4 -responses==0.25.6 -respx==0.22.0 -types-PyYAML==6.0.12.20241230 -types-requests==2.32.0.20241016 -types-setuptools==75.8.0.20250110 +black==26.3.1 +commitizen==4.13.10 +flake8==7.3.0 +isort==8.0.1 +mypy==1.20.1 +pylint==4.0.5 +pytest==9.0.3 +responses==0.26.0 +respx==0.23.1 +types-PyYAML==6.0.12.20260408 +types-requests==2.33.0.20260408 +types-setuptools==82.0.0.20260408 diff --git a/requirements-precommit.txt b/requirements-precommit.txt index 40a16fa94..fc2379223 100644 --- a/requirements-precommit.txt +++ b/requirements-precommit.txt @@ -1 +1 @@ -pre-commit==4.1.0 +pre-commit==4.5.1 diff --git a/requirements-test.txt b/requirements-test.txt index 9beda8f64..55ccf1a19 100644 --- a/requirements-test.txt +++ b/requirements-test.txt @@ -1,13 +1,13 @@ -r requirements.txt -anyio==4.8.0 -build==1.2.2.post1 -coverage==7.6.10 +anyio==4.13.0 +build==1.4.3 +coverage==7.13.5 pytest-console-scripts==1.4.1 -pytest-cov==6.0.0 -pytest-github-actions-annotate-failures==0.3.0 -pytest==8.3.4 -PyYaml==6.0.2 -responses==0.25.6 -respx==0.22.0 -trio==0.28.0 -wheel==0.45.1 +pytest-cov==7.1.0 +pytest-github-actions-annotate-failures==0.4.0 +pytest==9.0.3 +PyYaml==6.0.3 +responses==0.26.0 +respx==0.23.1 +trio==0.33.0 +wheel==0.46.3 diff --git a/requirements.txt b/requirements.txt index 21069f74f..31ae12e35 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -gql==3.5.0 +gql==4.0.0 httpx==0.28.1 -requests==2.32.3 +requests==2.33.1 requests-toolbelt==1.0.0 diff --git a/tests/functional/api/test_epics.py b/tests/functional/api/test_epics.py index a4f6765da..b61e23776 100644 --- a/tests/functional/api/test_epics.py +++ b/tests/functional/api/test_epics.py @@ -15,18 +15,20 @@ def test_epics(group): assert group.epics.list() -@pytest.mark.xfail(reason="404 on issue.id") def test_epic_issues(epic, issue): assert not epic.issues.list() + # FYI: Creating an issue causes a note to be created epic_issue = epic.issues.create({"issue_id": issue.id}) assert epic.issues.list() + # FYI: Deleting an issue causes a note to be created epic_issue.delete() def test_epic_notes(epic): - assert not epic.notes.list() + notes = epic.notes.list(get_all=True) epic.notes.create({"body": "Test note"}) - assert epic.notes.list() + new_notes = epic.notes.list(get_all=True) + assert len(new_notes) == (len(notes) + 1), f"{new_notes} {notes}" diff --git a/tests/functional/api/test_groups.py b/tests/functional/api/test_groups.py index 93200241a..301fea6a2 100644 --- a/tests/functional/api/test_groups.py +++ b/tests/functional/api/test_groups.py @@ -138,6 +138,34 @@ def test_group_labels(group): label.delete() +def test_group_avatar_upload(gl, group, fixture_dir): + """Test uploading an avatar to a group.""" + # Upload avatar + with open(fixture_dir / "avatar.png", "rb") as avatar_file: + group.avatar = avatar_file + group.save() + + # Verify the avatar was set + updated_group = gl.groups.get(group.id) + assert updated_group.avatar_url is not None + + +def test_group_avatar_remove(gl, group, fixture_dir): + """Test removing an avatar from a group.""" + # First set an avatar + with open(fixture_dir / "avatar.png", "rb") as avatar_file: + group.avatar = avatar_file + group.save() + + # Now remove the avatar + group.avatar = "" + group.save() + + # Verify the avatar was removed + updated_group = gl.groups.get(group.id) + assert updated_group.avatar_url is None + + @pytest.mark.gitlab_premium @pytest.mark.xfail(reason="/ldap/groups endpoint not documented") def test_ldap_groups(gl): @@ -284,6 +312,31 @@ def test_group_hooks(group): hook.delete() +def test_group_protected_branches(group, gitlab_version): + # Updating a protected branch at the group level is possible from Gitlab 15.9 + # https://docs.gitlab.com/api/group_protected_branches/ + can_update_prot_branch = gitlab_version.major > 15 or ( + gitlab_version.major == 15 and gitlab_version.minor >= 9 + ) + + p_b = group.protectedbranches.create( + {"name": "*-stable", "allow_force_push": False} + ) + assert p_b.name == "*-stable" + assert not p_b.allow_force_push + assert p_b in group.protectedbranches.list() + + if can_update_prot_branch: + p_b.allow_force_push = True + p_b.save() + + p_b = group.protectedbranches.get("*-stable") + if can_update_prot_branch: + assert p_b.allow_force_push + + p_b.delete() + + def test_group_transfer(gl, group): transfer_group = gl.groups.create( {"name": "transfer-test-group", "path": "transfer-test-group"} diff --git a/tests/functional/api/test_keys.py b/tests/functional/api/test_keys.py index 359649bef..6a2d660ed 100644 --- a/tests/functional/api/test_keys.py +++ b/tests/functional/api/test_keys.py @@ -38,6 +38,14 @@ def test_keys_deploy(gl, project, DEPLOY_KEY): key_by_fingerprint = gl.keys.get(fingerprint=fingerprint) assert key_by_fingerprint.title == key.title assert key_by_fingerprint.key == key.key - assert len(key_by_fingerprint.deploy_keys_projects) == 1 + + if not any( + key_project.get("project_id") == project.id + for key_project in key_by_fingerprint.deploy_keys_projects + ): + raise AssertionError( + f"Project {project} not found in 'deploy_keys_projects' " + f"{key_by_fingerprint.pformat()}" + ) key.delete() diff --git a/tests/functional/api/test_member_roles.py b/tests/functional/api/test_member_roles.py new file mode 100644 index 000000000..24cee7c69 --- /dev/null +++ b/tests/functional/api/test_member_roles.py @@ -0,0 +1,18 @@ +""" +GitLab API: +https://docs.gitlab.com/ee/api/member_roles.html +""" + + +def test_instance_member_role(gl): + member_role = gl.member_roles.create( + { + "name": "Custom webhook manager role", + "base_access_level": 20, + "description": "Custom reporter that can manage webhooks", + "admin_web_hook": True, + } + ) + assert member_role.id > 0 + assert member_role in gl.member_roles.list() + gl.member_roles.delete(member_role.id) diff --git a/tests/functional/api/test_project_feature_flag_user_lists.py b/tests/functional/api/test_project_feature_flag_user_lists.py new file mode 100644 index 000000000..ecf7972f9 --- /dev/null +++ b/tests/functional/api/test_project_feature_flag_user_lists.py @@ -0,0 +1,56 @@ +import pytest + +from gitlab import exceptions + + +@pytest.fixture +def user_list(project, user): + user_list = project.feature_flags_user_lists.create( + {"name": "test_user_list", "user_xids": str(user.id)} + ) + yield user_list + try: + user_list.delete() + except exceptions.GitlabDeleteError: + pass + + +def test_create_user_list(project, user): + user_list = project.feature_flags_user_lists.create( + {"name": "created_user_list", "user_xids": str(user.id)} + ) + assert user_list.name == "created_user_list" + assert str(user.id) in user_list.user_xids + user_list.delete() + + +def test_list_user_lists(project, user_list): + ff_user_lists = project.feature_flags_user_lists.list() + assert len(ff_user_lists) >= 1 + assert user_list.iid in [ff_user.iid for ff_user in ff_user_lists] + + +def test_get_user_list(project, user_list, user): + retrieved_list = project.feature_flags_user_lists.get(user_list.iid) + assert retrieved_list.name == user_list.name + assert str(user.id) in retrieved_list.user_xids + + +def test_update_user_list(project, user_list): + user_list.name = "updated_user_list" + user_list.save() + + updated_list = project.feature_flags_user_lists.get(user_list.iid) + assert updated_list.name == "updated_user_list" + + +def test_delete_user_list(project, user_list): + user_list.delete() + with pytest.raises(exceptions.GitlabGetError): + project.feature_flags_user_lists.get(user_list.iid) + + +def test_search_user_list(project, user_list): + ff_user_lists = project.feature_flags_user_lists.list(search=user_list.name) + assert len(ff_user_lists) >= 1 + assert user_list.iid in [ff_user.iid for ff_user in ff_user_lists] diff --git a/tests/functional/api/test_project_feature_flags.py b/tests/functional/api/test_project_feature_flags.py new file mode 100644 index 000000000..f555dc3d4 --- /dev/null +++ b/tests/functional/api/test_project_feature_flags.py @@ -0,0 +1,127 @@ +import pytest + +from gitlab import exceptions + + +@pytest.fixture +def feature_flag(project): + flag_name = "test_flag_fixture" + flag = project.feature_flags.create( + {"name": flag_name, "version": "new_version_flag"} + ) + yield flag + try: + flag.delete() + except exceptions.GitlabDeleteError: + pass + + +def test_create_feature_flag(project): + flag_name = "test_flag_create" + flag = project.feature_flags.create( + {"name": flag_name, "version": "new_version_flag"} + ) + assert flag.name == flag_name + assert flag.active is True + flag.delete() + + +def test_create_feature_flag_with_strategies(project): + flag_name = "test_flag_strategies" + strategies = [{"name": "userWithId", "parameters": {"userIds": "user1"}}] + flag = project.feature_flags.create( + {"name": flag_name, "version": "new_version_flag", "strategies": strategies} + ) + assert len(flag.strategies) == 1 + assert flag.strategies[0]["name"] == "userWithId" + assert flag.strategies[0]["parameters"]["userIds"] == "user1" + flag.delete() + + +def test_list_feature_flags(project, feature_flag): + flags = project.feature_flags.list() + assert len(flags) >= 1 + assert feature_flag.name in [f.name for f in flags] + + +def test_update_feature_flag(project, feature_flag): + feature_flag.active = False + feature_flag.save() + + updated_flag = project.feature_flags.get(feature_flag.name) + assert updated_flag.active is False + + +def test_rename_feature_flag(project, feature_flag): + # Rename via save() + new_name = "renamed_flag" + feature_flag.name = new_name + feature_flag.save() + + updated_flag = project.feature_flags.get(new_name) + assert updated_flag.name == new_name + + # Rename via update() + newer_name = "renamed_flag_2" + project.feature_flags.update(new_name, {"name": newer_name}) + + updated_flag_2 = project.feature_flags.get(newer_name) + assert updated_flag_2.name == newer_name + + # Update the fixture object so teardown can delete the correct flag + feature_flag.name = newer_name + + +def test_delete_feature_flag(project, feature_flag): + feature_flag.delete() + with pytest.raises(exceptions.GitlabGetError): + project.feature_flags.get(feature_flag.name) + + +def test_delete_feature_flag_strategy(project, feature_flag): + strategies = [ + {"name": "default", "parameters": {}}, + {"name": "userWithId", "parameters": {"userIds": "user1"}}, + ] + feature_flag.strategies = strategies + feature_flag.save() + + updated_feature_flag = project.feature_flags.get(feature_flag.name) + assert len(updated_feature_flag.strategies) == 2 + + # Remove strategy using _destroy + updated_strategies = updated_feature_flag.strategies + for strategy in updated_strategies: + if strategy["name"] == "userWithId": + strategy["_destroy"] = True + updated_feature_flag.save() + + updated_feature_flag = project.feature_flags.get(feature_flag.name) + assert len(updated_feature_flag.strategies) == 1 + assert updated_feature_flag.strategies[0]["name"] == "default" + + +def test_delete_feature_flag_scope(project, feature_flag): + strategies = [ + { + "name": "default", + "parameters": {}, + "scopes": [{"environment_scope": "*"}, {"environment_scope": "production"}], + } + ] + feature_flag.strategies = strategies + feature_flag.save() + + updated_feature_flag = project.feature_flags.get(feature_flag.name) + assert len(updated_feature_flag.strategies[0]["scopes"]) == 2 + + # Remove scope using _destroy + updated_strategies = updated_feature_flag.strategies + for scope in updated_strategies[0]["scopes"]: + if scope["environment_scope"] == "production": + scope["_destroy"] = True + updated_feature_flag.save() + + updated_feature_flag = project.feature_flags.get(feature_flag.name) + assert len(updated_feature_flag.strategies[0]["scopes"]) == 1 + assert updated_feature_flag.strategies[0]["scopes"][0]["environment_scope"] == "*" diff --git a/tests/functional/api/test_project_job_token_scope.py b/tests/functional/api/test_project_job_token_scope.py index 0d0466182..b1de0a7b2 100644 --- a/tests/functional/api/test_project_job_token_scope.py +++ b/tests/functional/api/test_project_job_token_scope.py @@ -1,3 +1,6 @@ +import pytest + + # https://docs.gitlab.com/ee/ci/jobs/ci_job_token.html#allow-any-project-to-access-your-project def test_enable_limit_access_to_this_project(gl, project): scope = project.job_token_scope.get() @@ -10,6 +13,7 @@ def test_enable_limit_access_to_this_project(gl, project): assert scope.inbound_enabled +@pytest.mark.xfail(reason="https://gitlab.com/gitlab-org/gitlab/-/issues/582271") def test_disable_limit_access_to_this_project(gl, project): scope = project.job_token_scope.get() diff --git a/tests/functional/api/test_projects.py b/tests/functional/api/test_projects.py index 3572c6115..c56b23ec7 100644 --- a/tests/functional/api/test_projects.py +++ b/tests/functional/api/test_projects.py @@ -26,9 +26,9 @@ def test_create_project(gl, user): sudo_project = gl.projects.create({"name": "sudo_project"}, sudo=user.id) - created = gl.projects.list() + created = gl.projects.list(get_all=True) created_gen = gl.projects.list(iterator=True) - owned = gl.projects.list(owned=True) + owned = gl.projects.list(owned=True, get_all=True) assert admin_project in created and sudo_project in created assert admin_project in owned and sudo_project not in owned @@ -48,6 +48,29 @@ def test_project_members(user, project): member.delete() +def test_project_avatar_upload(gl, project, fixture_dir): + """Test uploading an avatar to a project.""" + with open(fixture_dir / "avatar.png", "rb") as avatar_file: + project.avatar = avatar_file + project.save() + + updated_project = gl.projects.get(project.id) + assert updated_project.avatar_url is not None + + +def test_project_avatar_remove(gl, project, fixture_dir): + """Test removing an avatar from a project.""" + with open(fixture_dir / "avatar.png", "rb") as avatar_file: + project.avatar = avatar_file + project.save() + + project.avatar = "" + project.save() + + updated_project = gl.projects.get(project.id) + assert updated_project.avatar_url is None + + def test_project_badges(project): badge_image = "http://example.com" badge_link = "http://example/img.svg" diff --git a/tests/functional/api/test_registry.py b/tests/functional/api/test_registry.py index 91fdceacc..d234128ca 100644 --- a/tests/functional/api/test_registry.py +++ b/tests/functional/api/test_registry.py @@ -26,3 +26,8 @@ def test_project_protected_registry(project: Project): protected_registry.minimum_access_level_for_push = "owner" protected_registry.save() assert protected_registry.minimum_access_level_for_push == "owner" + + protected_registry.delete() + + rules = project.registry_protection_repository_rules.list() + assert rules == [] diff --git a/tests/functional/api/test_topics.py b/tests/functional/api/test_topics.py index 1fb7c8d63..0ac318458 100644 --- a/tests/functional/api/test_topics.py +++ b/tests/functional/api/test_topics.py @@ -31,3 +31,48 @@ def test_topics(gl, gitlab_version): assert merged_topic["id"] == topic2.id topic2.delete() + + +def test_topic_avatar_upload(gl, fixture_dir): + """Test uploading an avatar to a topic.""" + + topic = gl.topics.create( + { + "name": "avatar-topic", + "description": "Topic with avatar", + "title": "Avatar Topic", + } + ) + + with open(fixture_dir / "avatar.png", "rb") as avatar_file: + topic.avatar = avatar_file + topic.save() + + updated_topic = gl.topics.get(topic.id) + assert updated_topic.avatar_url is not None + + topic.delete() + + +def test_topic_avatar_remove(gl, fixture_dir): + """Test removing an avatar from a topic.""" + + topic = gl.topics.create( + { + "name": "avatar-topic-remove", + "description": "Remove avatar", + "title": "Remove Avatar", + } + ) + + with open(fixture_dir / "avatar.png", "rb") as avatar_file: + topic.avatar = avatar_file + topic.save() + + topic.avatar = "" + topic.save() + + updated_topic = gl.topics.get(topic.id) + assert updated_topic.avatar_url is None + + topic.delete() diff --git a/tests/functional/cli/test_cli_artifacts.py b/tests/functional/cli/test_cli_artifacts.py index 589486844..9fe4d01ef 100644 --- a/tests/functional/cli/test_cli_artifacts.py +++ b/tests/functional/cli/test_cli_artifacts.py @@ -7,14 +7,12 @@ import pytest -content = textwrap.dedent( - """\ +content = textwrap.dedent("""\ test-artifact: script: echo "test" > artifact.txt artifacts: untracked: true - """ -) + """) data = { "file_path": ".gitlab-ci.yml", "branch": "main", diff --git a/tests/functional/cli/test_cli_project_feature_flag_user_lists.py b/tests/functional/cli/test_cli_project_feature_flag_user_lists.py new file mode 100644 index 000000000..96e48379e --- /dev/null +++ b/tests/functional/cli/test_cli_project_feature_flag_user_lists.py @@ -0,0 +1,120 @@ +import json + +import pytest + + +@pytest.fixture +def user_list_cli(gitlab_cli, project, user): + list_name = "cli_test_list_fixture" + cmd = [ + "-o", + "json", + "project-feature-flag-user-list", + "create", + "--project-id", + str(project.id), + "--name", + list_name, + "--user-xids", + str(user.id), + ] + ret = gitlab_cli(cmd) + data = json.loads(ret.stdout) + iid = str(data["iid"]) + + yield iid + + try: + cmd = [ + "project-feature-flag-user-list", + "delete", + "--project-id", + str(project.id), + "--iid", + iid, + ] + gitlab_cli(cmd) + except Exception: + pass + + +def test_project_feature_flag_user_list_cli_create_delete(gitlab_cli, project, user): + list_name = "cli_test_list_create" + + cmd = [ + "-o", + "json", + "project-feature-flag-user-list", + "create", + "--project-id", + str(project.id), + "--name", + list_name, + "--user-xids", + str(user.id), + ] + ret = gitlab_cli(cmd) + assert ret.success + data = json.loads(ret.stdout) + assert data["name"] == list_name + assert str(user.id) in data["user_xids"] + iid = str(data["iid"]) + + cmd = [ + "project-feature-flag-user-list", + "delete", + "--project-id", + str(project.id), + "--iid", + iid, + ] + ret = gitlab_cli(cmd) + assert ret.success + + +def test_project_feature_flag_user_list_cli_list(gitlab_cli, project, user_list_cli): + cmd = [ + "-o", + "json", + "project-feature-flag-user-list", + "list", + "--project-id", + str(project.id), + ] + ret = gitlab_cli(cmd) + assert ret.success + data = json.loads(ret.stdout) + assert any(item["name"] == "cli_test_list_fixture" for item in data) + + +def test_project_feature_flag_user_list_cli_get(gitlab_cli, project, user_list_cli): + cmd = [ + "-o", + "json", + "project-feature-flag-user-list", + "get", + "--project-id", + str(project.id), + "--iid", + user_list_cli, + ] + ret = gitlab_cli(cmd) + assert ret.success + data = json.loads(ret.stdout) + assert data["name"] == "cli_test_list_fixture" + + +def test_project_feature_flag_user_list_cli_update(gitlab_cli, project, user_list_cli): + new_name = "cli_updated_list" + cmd = [ + "project-feature-flag-user-list", + "update", + "--project-id", + str(project.id), + "--iid", + user_list_cli, + "--name", + new_name, + ] + ret = gitlab_cli(cmd) + assert ret.success diff --git a/tests/functional/cli/test_cli_project_feature_flags.py b/tests/functional/cli/test_cli_project_feature_flags.py new file mode 100644 index 000000000..559970f26 --- /dev/null +++ b/tests/functional/cli/test_cli_project_feature_flags.py @@ -0,0 +1,203 @@ +import json + +import pytest + + +@pytest.fixture +def feature_flag_cli(gitlab_cli, project): + flag_name = "test_flag_cli_fixture" + cmd = [ + "project-feature-flag", + "create", + "--project-id", + str(project.id), + "--name", + flag_name, + ] + gitlab_cli(cmd) + yield flag_name + try: + cmd = [ + "project-feature-flag", + "delete", + "--project-id", + str(project.id), + "--name", + flag_name, + ] + gitlab_cli(cmd) + except Exception: + pass + + +def test_project_feature_flag_cli_create_delete(gitlab_cli, project): + flag_name = "test_flag_cli_create" + cmd = [ + "project-feature-flag", + "create", + "--project-id", + str(project.id), + "--name", + flag_name, + ] + ret = gitlab_cli(cmd) + assert ret.success + assert flag_name in ret.stdout + + cmd = [ + "project-feature-flag", + "delete", + "--project-id", + str(project.id), + "--name", + flag_name, + ] + ret = gitlab_cli(cmd) + assert ret.success + + +def test_project_feature_flag_cli_create_with_strategies(gitlab_cli, project): + flag_name = "test_flag_cli_strategies" + strategies_json = ( + '[{"name": "userWithId", "parameters": {"userIds": "user1,user2"}}]' + ) + + cmd = [ + "project-feature-flag", + "create", + "--project-id", + str(project.id), + "--name", + flag_name, + "--strategies", + strategies_json, + ] + ret = gitlab_cli(cmd) + assert ret.success + + cmd = [ + "-o", + "json", + "project-feature-flag", + "get", + "--project-id", + str(project.id), + "--name", + flag_name, + ] + ret = gitlab_cli(cmd) + assert ret.success + data = json.loads(ret.stdout) + assert len(data["strategies"]) == 1 + assert data["strategies"][0]["name"] == "userWithId" + + +def test_project_feature_flag_cli_list(gitlab_cli, project, feature_flag_cli): + cmd = ["project-feature-flag", "list", "--project-id", str(project.id)] + ret = gitlab_cli(cmd) + assert ret.success + assert feature_flag_cli in ret.stdout + + +def test_project_feature_flag_cli_get(gitlab_cli, project, feature_flag_cli): + cmd = [ + "project-feature-flag", + "get", + "--project-id", + str(project.id), + "--name", + feature_flag_cli, + ] + ret = gitlab_cli(cmd) + assert ret.success + assert feature_flag_cli in ret.stdout + + +def test_project_feature_flag_cli_update(gitlab_cli, project, feature_flag_cli): + cmd = [ + "project-feature-flag", + "update", + "--project-id", + str(project.id), + "--name", + feature_flag_cli, + "--active", + "false", + ] + ret = gitlab_cli(cmd) + assert ret.success + + cmd = [ + "-o", + "json", + "project-feature-flag", + "get", + "--project-id", + str(project.id), + "--name", + feature_flag_cli, + ] + ret = gitlab_cli(cmd) + assert ret.success + data = json.loads(ret.stdout) + assert data["active"] is False + + +def test_project_feature_flag_cli_create_with_malformed_strategies(gitlab_cli, project): + flag_name = "test_flag_cli_malformed_strategies" + strategies_json = '[{"name": "userWithId"' # Malformed JSON + + cmd = [ + "project-feature-flag", + "create", + "--project-id", + str(project.id), + "--name", + flag_name, + "--strategies", + strategies_json, + ] + ret = gitlab_cli(cmd) + assert not ret.success + assert "Could not parse JSON data" in ret.stderr + + +def test_project_feature_flag_cli_rename(gitlab_cli, project, feature_flag_cli): + new_name = "cli_renamed_flag" + cmd = [ + "project-feature-flag", + "update", + "--project-id", + str(project.id), + "--name", + feature_flag_cli, + "--new-name", + new_name, + ] + ret = gitlab_cli(cmd) + assert ret.success + + cmd = [ + "-o", + "json", + "project-feature-flag", + "get", + "--project-id", + str(project.id), + "--name", + new_name, + ] + ret = gitlab_cli(cmd) + assert ret.success + data = json.loads(ret.stdout) + assert data["name"] == new_name + # Cleanup renamed flag + cmd = [ + "project-feature-flag", + "delete", + "--project-id", + str(project.id), + "--name", + new_name, + ] + gitlab_cli(cmd) diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py index 3ea2768ab..f4f2f6df3 100644 --- a/tests/functional/conftest.py +++ b/tests/functional/conftest.py @@ -8,7 +8,7 @@ import time import uuid from subprocess import check_output -from typing import Sequence +from typing import Sequence, TYPE_CHECKING import pytest import requests @@ -260,6 +260,7 @@ def gl(gitlab_url: str, gitlab_token: str) -> gitlab.Gitlab: logging.info("Instantiating python-gitlab gitlab.Gitlab instance") instance = gitlab.Gitlab(gitlab_url, private_token=gitlab_token) + instance.auth() logging.info("Reset GitLab") reset_gitlab(instance) @@ -291,21 +292,25 @@ def gitlab_ultimate(gitlab_plan, request) -> None: @pytest.fixture(scope="session") -def gitlab_runner(gl): +def gitlab_runner(gl: gitlab.Gitlab): container = "gitlab-runner-test" - runner_name = "python-gitlab-runner" - token = "registration-token" + runner_description = "python-gitlab-runner" + if TYPE_CHECKING: + assert gl.user is not None + + runner = gl.user.runners.create( + {"runner_type": "instance_type", "run_untagged": True} + ) url = "http://gitlab" docker_exec = ["docker", "exec", container, "gitlab-runner"] register = [ "register", - "--run-untagged", "--non-interactive", - "--registration-token", - token, - "--name", - runner_name, + "--token", + runner.token, + "--description", + runner_description, "--url", url, "--clone-url", @@ -313,11 +318,10 @@ def gitlab_runner(gl): "--executor", "shell", ] - unregister = ["unregister", "--name", runner_name] yield check_output(docker_exec + register).decode() - check_output(docker_exec + unregister).decode() + gl.runners.delete(token=runner.token) @pytest.fixture(scope="module") diff --git a/tests/functional/fixtures/.env b/tests/functional/fixtures/.env index a25baaa07..60eda1be2 100644 --- a/tests/functional/fixtures/.env +++ b/tests/functional/fixtures/.env @@ -1,4 +1,4 @@ GITLAB_IMAGE=gitlab/gitlab-ee -GITLAB_TAG=17.8.1-ee.0 +GITLAB_TAG=18.9.2-ee.0 GITLAB_RUNNER_IMAGE=gitlab/gitlab-runner -GITLAB_RUNNER_TAG=v17.8.3 +GITLAB_RUNNER_TAG=96856197 diff --git a/tests/functional/fixtures/docker-compose.yml b/tests/functional/fixtures/docker-compose.yml index 550ec156c..17562d5be 100644 --- a/tests/functional/fixtures/docker-compose.yml +++ b/tests/functional/fixtures/docker-compose.yml @@ -12,7 +12,6 @@ services: privileged: true # Just in case https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/1350 environment: GITLAB_ROOT_PASSWORD: 5iveL!fe - GITLAB_SHARED_RUNNERS_REGISTRATION_TOKEN: registration-token GITLAB_OMNIBUS_CONFIG: | external_url 'http://127.0.0.1:8080' registry['enable'] = false @@ -35,7 +34,7 @@ services: entrypoint: - /bin/sh - -c - - ruby /create_license.rb && /assets/wrapper + - ruby /create_license.rb && /assets/init-container volumes: - ${PWD}/tests/functional/fixtures/create_license.rb:/create_license.rb ports: diff --git a/tests/functional/helpers.py b/tests/functional/helpers.py index 090673bf7..9d313e540 100644 --- a/tests/functional/helpers.py +++ b/tests/functional/helpers.py @@ -9,6 +9,7 @@ import gitlab import gitlab.base import gitlab.exceptions +import gitlab.v4.objects SLEEP_INTERVAL = 0.5 TIMEOUT = 60 # seconds before timeout will occur @@ -37,6 +38,11 @@ def safe_delete(object: gitlab.base.RESTObject) -> None: object = manager.get(object.get_id()) # type: ignore[attr-defined] except gitlab.exceptions.GitlabGetError: return + # If object is already marked for deletion we have succeeded + if getattr(object, "marked_for_deletion_on", None) is not None: + # 'Group' and 'Project' objects have a 'marked_for_deletion_on' attribute + logging.info(f"{object!r} is marked for deletion.") + return if index: logging.info(f"Attempt {index + 1} to delete {object!r}.") @@ -52,22 +58,16 @@ def safe_delete(object: gitlab.base.RESTObject) -> None: # we shouldn't cause test to fail if it still exists return elif isinstance(object, gitlab.v4.objects.Project): - # Immediately delete rather than waiting for at least 1day - # https://docs.gitlab.com/ee/api/projects.html#delete-project - object.delete(permanently_remove=True) - pass + # Starting in GitLab 18, projects can't be immediately deleted. + # So this will mark it for deletion. + object.delete() else: # We only attempt to delete parent groups to prevent dangling sub-groups - # However parent groups can only be deleted on a delay in Gl 16 + # However parent groups can only be deleted on a delay in GitLab 16 # https://docs.gitlab.com/ee/api/groups.html#remove-group object.delete() except gitlab.exceptions.GitlabDeleteError: - logging.info(f"{object!r} already deleted or scheduled for deletion.") - if isinstance(object, gitlab.v4.objects.Group): - # Parent groups can never be immediately deleted in GL 16, - # so don't cause test to fail if it still exists - return - pass + logging.exception(f"Error attempting to delete: {object.pformat()}") time.sleep(SLEEP_INTERVAL) pytest.fail(f"{object!r} was not deleted") diff --git a/tests/unit/objects/test_group_access_tokens.py b/tests/unit/objects/test_group_access_tokens.py index 53b636284..c09ed8e12 100644 --- a/tests/unit/objects/test_group_access_tokens.py +++ b/tests/unit/objects/test_group_access_tokens.py @@ -91,6 +91,19 @@ def resp_rotate_group_access_token(token_content): yield rsps +@pytest.fixture +def resp_self_rotate_group_access_token(token_content): + with responses.RequestsMock() as rsps: + rsps.add( + method=responses.POST, + url="http://localhost/api/v4/groups/1/access_tokens/self/rotate", + json=token_content, + content_type="application/json", + status=200, + ) + yield rsps + + def test_list_group_access_tokens(gl, resp_list_group_access_token): access_tokens = gl.groups.get(1, lazy=True).access_tokens.list() assert len(access_tokens) == 1 @@ -127,3 +140,15 @@ def test_rotate_group_access_token(group, resp_rotate_group_access_token): access_token.rotate() assert isinstance(access_token, GroupAccessToken) assert access_token.token == "s3cr3t" + + +def test_self_rotate_group_access_token(group, resp_self_rotate_group_access_token): + access_token = group.access_tokens.get(1, lazy=True) + access_token.rotate(self_rotate=True) + assert isinstance(access_token, GroupAccessToken) + assert access_token.token == "s3cr3t" + + # Verify that the url contains "self" + rotation_calls = resp_self_rotate_group_access_token.calls + assert len(rotation_calls) == 1 + assert "self/rotate" in rotation_calls[0].request.url diff --git a/tests/unit/objects/test_member_roles.py b/tests/unit/objects/test_member_roles.py new file mode 100644 index 000000000..948f5a53b --- /dev/null +++ b/tests/unit/objects/test_member_roles.py @@ -0,0 +1,209 @@ +""" +GitLab API: https://docs.gitlab.com/ee/api/status_checks.html +""" + +import pytest +import responses + + +@pytest.fixture +def member_roles(): + return { + "id": 2, + "name": "Custom role", + "description": "Custom guest that can read code", + "group_id": None, + "base_access_level": 10, + "admin_cicd_variables": False, + "admin_compliance_framework": False, + "admin_group_member": False, + "admin_merge_request": False, + "admin_push_rules": False, + "admin_terraform_state": False, + "admin_vulnerability": False, + "admin_web_hook": False, + "archive_project": False, + "manage_deploy_tokens": False, + "manage_group_access_tokens": False, + "manage_merge_request_settings": False, + "manage_project_access_tokens": False, + "manage_security_policy_link": False, + "read_code": True, + "read_runners": False, + "read_dependency": False, + "read_vulnerability": False, + "remove_group": False, + "remove_project": False, + } + + +@pytest.fixture +def create_member_role(): + return { + "id": 3, + "name": "Custom webhook manager role", + "description": "Custom reporter that can manage webhooks", + "group_id": None, + "base_access_level": 20, + "admin_cicd_variables": False, + "admin_compliance_framework": False, + "admin_group_member": False, + "admin_merge_request": False, + "admin_push_rules": False, + "admin_terraform_state": False, + "admin_vulnerability": False, + "admin_web_hook": True, + "archive_project": False, + "manage_deploy_tokens": False, + "manage_group_access_tokens": False, + "manage_merge_request_settings": False, + "manage_project_access_tokens": False, + "manage_security_policy_link": False, + "read_code": False, + "read_runners": False, + "read_dependency": False, + "read_vulnerability": False, + "remove_group": False, + "remove_project": False, + } + + +@pytest.fixture +def resp_list_member_roles(member_roles): + with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: + rsps.add( + method=responses.GET, + url="http://localhost/api/v4/member_roles", + json=[member_roles], + content_type="application/json", + status=200, + ) + yield rsps + + +@pytest.fixture +def resp_create_member_roles(create_member_role): + with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: + rsps.add( + method=responses.POST, + url="http://localhost/api/v4/member_roles", + json=create_member_role, + content_type="application/json", + status=200, + ) + yield rsps + + +@pytest.fixture +def resp_delete_member_roles(): + content = [] + + with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: + rsps.add( + method=responses.DELETE, + url="http://localhost/api/v4/member_roles/1", + status=204, + ) + rsps.add( + method=responses.GET, + url="http://localhost/api/v4/member_roles", + json=content, + content_type="application/json", + status=200, + ) + yield rsps + + +@pytest.fixture +def resp_list_group_member_roles(member_roles): + with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: + rsps.add( + method=responses.GET, + url="http://localhost/api/v4/groups/1/member_roles", + json=[member_roles], + content_type="application/json", + status=200, + ) + yield rsps + + +@pytest.fixture +def resp_create_group_member_roles(create_member_role): + with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: + rsps.add( + method=responses.POST, + url="http://localhost/api/v4/groups/1/member_roles", + json=create_member_role, + content_type="application/json", + status=200, + ) + yield rsps + + +@pytest.fixture +def resp_delete_group_member_roles(): + content = [] + + with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps: + rsps.add( + method=responses.DELETE, + url="http://localhost/api/v4/groups/1/member_roles/1", + status=204, + ) + rsps.add( + method=responses.GET, + url="http://localhost/api/v4/groups/1/member_roles", + json=content, + content_type="application/json", + status=200, + ) + yield rsps + + +def test_list_member_roles(gl, resp_list_member_roles): + member_roles = gl.member_roles.list() + assert len(member_roles) == 1 + assert member_roles[0].name == "Custom role" + + +def test_create_member_roles(gl, resp_create_member_roles): + member_role = gl.member_roles.create( + { + "name": "Custom webhook manager role", + "base_access_level": 20, + "description": "Custom reporter that can manage webhooks", + "admin_web_hook": True, + } + ) + assert member_role.name == "Custom webhook manager role" + assert member_role.base_access_level == 20 + + +def test_delete_member_roles(gl, resp_delete_member_roles): + gl.member_roles.delete(1) + member_roles_after_delete = gl.member_roles.list() + assert len(member_roles_after_delete) == 0 + + +def test_list_group_member_roles(gl, resp_list_group_member_roles): + member_roles = gl.groups.get(1, lazy=True).member_roles.list() + assert len(member_roles) == 1 + + +def test_create_group_member_roles(gl, resp_create_group_member_roles): + member_role = gl.groups.get(1, lazy=True).member_roles.create( + { + "name": "Custom webhook manager role", + "base_access_level": 20, + "description": "Custom reporter that can manage webhooks", + "admin_web_hook": True, + } + ) + assert member_role.name == "Custom webhook manager role" + assert member_role.base_access_level == 20 + + +def test_delete_group_member_roles(gl, resp_delete_group_member_roles): + gl.groups.get(1, lazy=True).member_roles.delete(1) + member_roles_after_delete = gl.groups.get(1, lazy=True).member_roles.list() + assert len(member_roles_after_delete) == 0 diff --git a/tests/unit/objects/test_personal_access_tokens.py b/tests/unit/objects/test_personal_access_tokens.py index 1301f5ffb..6272cecc1 100644 --- a/tests/unit/objects/test_personal_access_tokens.py +++ b/tests/unit/objects/test_personal_access_tokens.py @@ -102,6 +102,19 @@ def resp_rotate_personal_access_token(token_content): yield rsps +@pytest.fixture +def resp_self_rotate_personal_access_token(token_content): + with responses.RequestsMock() as rsps: + rsps.add( + method=responses.POST, + url="http://localhost/api/v4/personal_access_tokens/self/rotate", + json=token_content, + content_type="application/json", + status=200, + ) + yield rsps + + def test_create_personal_access_token(gl, resp_create_user_personal_access_token): user = gl.users.get(1, lazy=True) access_token = user.personal_access_tokens.create( @@ -148,8 +161,20 @@ def test_revoke_personal_access_token_by_id(gl, resp_delete_personal_access_toke gl.personal_access_tokens.delete(token_id) -def test_rotate_project_access_token(gl, resp_rotate_personal_access_token): +def test_rotate_personal_access_token(gl, resp_rotate_personal_access_token): access_token = gl.personal_access_tokens.get(1, lazy=True) access_token.rotate() assert isinstance(access_token, PersonalAccessToken) assert access_token.token == "s3cr3t" + + +def test_self_rotate_personal_access_token(gl, resp_self_rotate_personal_access_token): + access_token = gl.personal_access_tokens.get(1, lazy=True) + access_token.rotate(self_rotate=True) + assert isinstance(access_token, PersonalAccessToken) + assert access_token.token == "s3cr3t" + + # Verify that the url contains "self" + rotation_calls = resp_self_rotate_personal_access_token.calls + assert len(rotation_calls) == 1 + assert "self/rotate" in rotation_calls[0].request.url diff --git a/tests/unit/objects/test_project_access_tokens.py b/tests/unit/objects/test_project_access_tokens.py index b63eeaa32..77b5108fe 100644 --- a/tests/unit/objects/test_project_access_tokens.py +++ b/tests/unit/objects/test_project_access_tokens.py @@ -91,6 +91,19 @@ def resp_rotate_project_access_token(token_content): yield rsps +@pytest.fixture +def resp_self_rotate_project_access_token(token_content): + with responses.RequestsMock() as rsps: + rsps.add( + method=responses.POST, + url="http://localhost/api/v4/projects/1/access_tokens/self/rotate", + json=token_content, + content_type="application/json", + status=200, + ) + yield rsps + + def test_list_project_access_tokens(gl, resp_list_project_access_token): access_tokens = gl.projects.get(1, lazy=True).access_tokens.list() assert len(access_tokens) == 1 @@ -127,3 +140,17 @@ def test_rotate_project_access_token(project, resp_rotate_project_access_token): access_token.rotate() assert isinstance(access_token, ProjectAccessToken) assert access_token.token == "s3cr3t" + + +def test_self_rotate_project_access_token( + project, resp_self_rotate_project_access_token +): + access_token = project.access_tokens.get(1, lazy=True) + access_token.rotate(self_rotate=True) + assert isinstance(access_token, ProjectAccessToken) + assert access_token.token == "s3cr3t" + + # Verify that the url contains "self" + rotation_calls = resp_self_rotate_project_access_token.calls + assert len(rotation_calls) == 1 + assert "self/rotate" in rotation_calls[0].request.url diff --git a/tests/unit/objects/test_project_feature_flag_user_lists.py b/tests/unit/objects/test_project_feature_flag_user_lists.py new file mode 100644 index 000000000..92a9fd13e --- /dev/null +++ b/tests/unit/objects/test_project_feature_flag_user_lists.py @@ -0,0 +1,30 @@ +""" +Unit tests for Project Feature Flag User Lists. +""" + +import responses + + +def test_create_user_list_with_list_conversion(project): + """ + Verify that passing a list of integers for user_xids is converted + to a comma-separated string in the API payload. + """ + with responses.RequestsMock() as rs: + rs.add( + responses.POST, + "http://localhost/api/v4/projects/1/feature_flags_user_lists", + json={"iid": 1, "name": "list", "user_xids": "1,2,3"}, + status=201, + match=[ + responses.matchers.json_params_matcher( + {"name": "list", "user_xids": "1,2,3"} + ) + ], + ) + + project.feature_flags_user_lists.create( + {"name": "list", "user_xids": [1, 2, 3]} + ) + + assert len(rs.calls) == 1 diff --git a/tests/unit/objects/test_project_feature_flags.py b/tests/unit/objects/test_project_feature_flags.py new file mode 100644 index 000000000..a74fb7ee6 --- /dev/null +++ b/tests/unit/objects/test_project_feature_flags.py @@ -0,0 +1,35 @@ +""" +Unit tests for Project Feature Flags. +""" + +import responses + +from gitlab.v4.objects import ProjectFeatureFlag + + +def test_feature_flag_rename(project): + """ + Verify that renaming a feature flag uses the old name in the URL + and the new name in the payload. + """ + flag_content = {"name": "old_name", "version": "new_version_flag", "active": True} + flag = ProjectFeatureFlag(project.feature_flags, flag_content) + + # Rename locally + flag.name = "new_name" + + with responses.RequestsMock() as rs: + rs.add( + responses.PUT, + "http://localhost/api/v4/projects/1/feature_flags/old_name", + json={"name": "new_name", "version": "new_version_flag", "active": True}, + status=200, + match=[responses.matchers.json_params_matcher({"name": "new_name"})], + ) + + flag.save() + + assert len(rs.calls) == 1 + # URL should use the old name (ID) + assert rs.calls[0].request.url.endswith("/feature_flags/old_name") + assert flag.name == "new_name" diff --git a/tests/unit/objects/test_registry_protection_rules.py b/tests/unit/objects/test_registry_protection_rules.py index 3078278f5..3e9db414a 100644 --- a/tests/unit/objects/test_registry_protection_rules.py +++ b/tests/unit/objects/test_registry_protection_rules.py @@ -58,6 +58,17 @@ def resp_update_protected_registry(): yield rsps +@pytest.fixture +def resp_delete_protected_registry(): + with responses.RequestsMock() as rsps: + rsps.add( + method=responses.DELETE, + url="http://localhost/api/v4/projects/1/registry/protection/repository/rules/1", + status=204, + ) + yield rsps + + def test_list_project_protected_registries(project, resp_list_protected_registries): protected_registry = project.registry_protection_repository_rules.list()[0] assert isinstance(protected_registry, ProjectRegistryRepositoryProtectionRule) @@ -80,3 +91,7 @@ def test_update_project_protected_registry(project, resp_update_protected_regist 1, {"repository_path_pattern": "abc*"} ) assert updated["repository_path_pattern"] == "abc*" + + +def test_delete_project_protected_registry(project, resp_delete_protected_registry): + project.registry_protection_repository_rules.delete(1) diff --git a/tests/unit/objects/test_remote_mirrors.py b/tests/unit/objects/test_remote_mirrors.py index f493032e8..be2aaaaba 100644 --- a/tests/unit/objects/test_remote_mirrors.py +++ b/tests/unit/objects/test_remote_mirrors.py @@ -54,6 +54,12 @@ def resp_remote_mirrors(): url="http://localhost/api/v4/projects/1/remote_mirrors/1", status=204, ) + + rsps.add( + method=responses.POST, + url="http://localhost/api/v4/projects/1/remote_mirrors/1/sync", + status=204, + ) yield rsps @@ -81,3 +87,9 @@ def test_update_project_remote_mirror(project, resp_remote_mirrors): def test_delete_project_remote_mirror(project, resp_remote_mirrors): mirror = project.remote_mirrors.create({"url": "https://example.com"}) mirror.delete() + + +def test_sync_project_remote_mirror(project, resp_remote_mirrors): + mirror = project.remote_mirrors.create({"url": "https://example.com"}) + response = mirror.sync() + assert response.status_code == 204 diff --git a/tests/unit/objects/test_users.py b/tests/unit/objects/test_users.py index c120581fe..ff8c4479d 100644 --- a/tests/unit/objects/test_users.py +++ b/tests/unit/objects/test_users.py @@ -7,7 +7,13 @@ import pytest import responses -from gitlab.v4.objects import StarredProject, User, UserMembership, UserStatus +from gitlab.v4.objects import ( + StarredProject, + User, + UserContributedProject, + UserMembership, + UserStatus, +) from .test_projects import project_content @@ -242,6 +248,19 @@ def resp_starred_projects(): yield rsps +@pytest.fixture +def resp_contributed_projects(): + with responses.RequestsMock() as rsps: + rsps.add( + method=responses.GET, + url="http://localhost/api/v4/users/1/contributed_projects", + json=[project_content], + content_type="application/json", + status=200, + ) + yield rsps + + @pytest.fixture def resp_runner_create(): with responses.RequestsMock() as rsps: @@ -314,6 +333,12 @@ def test_list_followers(user, resp_followers_following): assert followings[1].id == 4 +def test_list_contributed_projects(user, resp_contributed_projects): + projects = user.contributed_projects.list() + assert isinstance(projects[0], UserContributedProject) + assert projects[0].id == project_content["id"] + + def test_list_starred_projects(user, resp_starred_projects): projects = user.starred_projects.list() assert isinstance(projects[0], StarredProject) diff --git a/tests/unit/test_cli.py b/tests/unit/test_cli.py index af3dd3380..cad27afba 100644 --- a/tests/unit/test_cli.py +++ b/tests/unit/test_cli.py @@ -161,7 +161,7 @@ def error(self, message): "Raise error instead of exiting on invalid arguments, to make testing easier" raise ValueError(message) - class Fake: + class Fake(gitlab.base.RESTObject): _id_attr = None class FakeManager(CreateMixin, UpdateMixin, gitlab.base.RESTManager): diff --git a/tests/unit/test_config.py b/tests/unit/test_config.py index 32b9c9ef9..b8470f22b 100644 --- a/tests/unit/test_config.py +++ b/tests/unit/test_config.py @@ -268,28 +268,22 @@ def test_ssl_verify_as_str(m_open, monkeypatch): def test_data_from_helper(m_open, monkeypatch, tmp_path): helper = tmp_path / "helper.sh" helper.write_text( - dedent( - """\ + dedent("""\ #!/bin/sh echo "secret" - """ - ), + """), encoding="utf-8", ) helper.chmod(0o755) - fd = io.StringIO( - dedent( - f"""\ + fd = io.StringIO(dedent(f"""\ [global] default = helper [helper] url = https://helper.url oauth_token = helper: {helper} - """ - ) - ) + """)) fd.close = mock.Mock(return_value=None) m_open.return_value = fd @@ -306,18 +300,14 @@ def test_data_from_helper(m_open, monkeypatch, tmp_path): @pytest.mark.skipif(sys.platform.startswith("win"), reason="Not supported on Windows") def test_from_helper_subprocess_error_raises_error(m_open, monkeypatch): # using false here to force a non-zero return code - fd = io.StringIO( - dedent( - """\ + fd = io.StringIO(dedent("""\ [global] default = helper [helper] url = https://helper.url oauth_token = helper: false - """ - ) - ) + """)) fd.close = mock.Mock(return_value=None) m_open.return_value = fd diff --git a/tests/unit/test_types.py b/tests/unit/test_types.py index 351f6ca34..0c1b6b8ed 100644 --- a/tests/unit/test_types.py +++ b/tests/unit/test_types.py @@ -1,6 +1,6 @@ import pytest -from gitlab import types +from gitlab import exceptions, types class TestRequiredOptional: @@ -122,3 +122,40 @@ def test_csv_string_attribute_get_for_api_from_int_list(): def test_lowercase_string_attribute_get_for_api(): o = types.LowercaseStringAttribute("FOO") assert o.get_for_api(key="spam") == ("spam", "foo") + + +# JsonAttribute tests +def test_json_attribute() -> None: + attr = types.JsonAttribute() + + attr.set_from_cli('{"key": "value"}') + assert attr.get() == {"key": "value"} + + with pytest.raises(exceptions.GitlabParsingError): + attr.set_from_cli(" ") + + +# CommaSeparatedStringAttribute tests +def test_comma_separated_string_attribute() -> None: + # Test with list of integers + attr = types.CommaSeparatedStringAttribute([1, 2, 3]) + assert attr.get_for_api(key="ids") == ("ids", "1,2,3") + + # Test with list of strings + attr = types.CommaSeparatedStringAttribute(["a", "b"]) + assert attr.get_for_api(key="names") == ("names", "a,b") + + # Test with string value (should be preserved) + attr = types.CommaSeparatedStringAttribute("1,2,3") + assert attr.get_for_api(key="ids") == ("ids", "1,2,3") + + # Test CLI setting + attr = types.CommaSeparatedStringAttribute() + attr.set_from_cli("1, 2, 3") + assert attr.get() == ["1", "2", "3"] + + attr.set_from_cli("") + assert attr.get() == [] + + # Verify transform_in_body is True + assert types.CommaSeparatedStringAttribute.transform_in_body is True diff --git a/tox.ini b/tox.ini index 05a15c6c4..0ba295692 100644 --- a/tox.ini +++ b/tox.ini @@ -2,14 +2,14 @@ minversion = 4.0 skipsdist = True skip_missing_interpreters = True -envlist = py313,py312,py311,py310,py39,black,isort,flake8,mypy,twine-check,cz,pylint +envlist = py314,py313,py312,py311,py310,black,isort,flake8,mypy,twine-check,cz,pylint # NOTE(jlvillal): To use a label use the `-m` flag. # For example to run the `func` label group of environments do: # tox -m func labels = lint = black,isort,flake8,mypy,pylint,cz - unit = py313,py312,py311,py310,py39,py38 + unit = py314,py313,py312,py311,py310 # func is the functional tests. This is very time consuming. func = cli_func_v4,api_func_v4