Skip to content

Update and fix variable _create_attrs and _update_attrs #3379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PhilipNelson5 wants to merge 2 commits into
base: main
Choose a base branch
from
+64 −7
Open

Update and fix variable _create_attrs and _update_attrs #3379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7b45c8
test: add test for hidden variables
PhilipNelson5 Mar 25, 2026
b8e89f5
feat(api): add 'masked_and_hidden' to the optional variable create attrs
PhilipNelson5 Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ docs/_build
.tox
.venv/
venv/
.mypy_cache/

# Include tracked hidden files and directories in search and diff tools
!.dockerignore
Expand Down
22 changes: 15 additions & 7 deletions gitlab/v4/objects/variables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ class VariableManager(CRUDMixin[Variable]):
_path = "/admin/ci/variables"
_obj_cls = Variable
_create_attrs = RequiredOptional(
required=("key", "value"), optional=("protected", "variable_type", "masked")
required=("key", "value"),
optional=("protected", "variable_type", "masked", "masked_and_hidden"),
)
_update_attrs = RequiredOptional(
required=("key", "value"), optional=("protected", "variable_type", "masked")
required=("key",), optional=("value", "protected", "variable_type", "masked")
)


Expand All @@ -43,10 +44,11 @@ class GroupVariableManager(CRUDMixin[GroupVariable]):
_obj_cls = GroupVariable
_from_parent_attrs = {"group_id": "id"}
_create_attrs = RequiredOptional(
required=("key", "value"), optional=("protected", "variable_type", "masked")
required=("key", "value"),
optional=("protected", "variable_type", "masked", "masked_and_hidden"),
)
_update_attrs = RequiredOptional(
required=("key", "value"), optional=("protected", "variable_type", "masked")
required=("key",), optional=("value", "protected", "variable_type", "masked")
)


Expand All @@ -60,9 +62,15 @@ class ProjectVariableManager(CRUDMixin[ProjectVariable]):
_from_parent_attrs = {"project_id": "id"}
_create_attrs = RequiredOptional(
required=("key", "value"),
optional=("protected", "variable_type", "masked", "environment_scope"),
optional=(
"protected",
"variable_type",
"masked",
"environment_scope",
"masked_and_hidden",
),
)
_update_attrs = RequiredOptional(
required=("key", "value"),
optional=("protected", "variable_type", "masked", "environment_scope"),
required=("key",),
optional=("value", "protected", "variable_type", "masked", "environment_scope"),
)
48 changes: 48 additions & 0 deletions tests/functional/api/test_variables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,51 @@ def test_project_variables(project):
assert variable.value == "new_value1"

variable.delete()


def test_hidden_instance_variables(gl):
variable = gl.variables.create(
{"key": "key1", "value": "secret_value", "masked_and_hidden": True}
)
assert variable.value is None
assert variable.description is None
assert variable in gl.variables.list()

variable.description = "new_description"
variable.save()
variable = gl.variables.get(variable.key)
assert variable.description == "new_description"

variable.delete()


def test_hidden_group_variables(group):
variable = group.variables.create(
{"key": "key1", "value": "secret_value", "masked_and_hidden": True}
)
assert variable.value is None
assert variable.description is None
assert variable in group.variables.list()

variable.description = "new_description"
variable.save()
variable = group.variables.get(variable.key)
assert variable.description == "new_description"

variable.delete()


def test_hidden_project_variables(project):
variable = project.variables.create(
{"key": "key1", "value": "secret_value", "masked_and_hidden": True}
)
assert variable.value is None
assert variable.description is None
assert variable in project.variables.list()

variable.description = "new_description"
variable.save()
variable = project.variables.get(variable.key)
assert variable.description == "new_description"

variable.delete()
Loading