Skip to content

Handle project push rule REST API. #839

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
wants to merge 1 commit into
base: 12.0
Choose a base branch
from
Open

Handle project push rule REST API. #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
124 changes: 124 additions & 0 deletions src/Api/Projects.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,130 @@ public function deleteDeployToken(int|string $project_id, int $token_id): mixed
return $this->delete($this->getProjectPath($project_id, 'deploy_tokens/'.self::encodePath($token_id)));
}

public function pushRule(int|string $project_id): mixed
{
return $this->get($this->getProjectPath($project_id, 'push_rule'));
}

public function createPushRule(int|string $project_id, array $parameters = []): mixed
{
$resolver = $this->createOptionsResolver();
$booleanNormalizer = function (Options $resolver, $value): string {
return $value ? 'true' : 'false';
};

$resolver->setDefined('author_email_regex')
->setAllowedTypes('author_email_regex', 'string')
;
$resolver->setDefined('branch_name_regex')
->setAllowedTypes('branch_name_regex', 'string')
;
$resolver->setDefined('commit_message_negative_regex')
->setAllowedTypes('commit_message_negative_regex', 'string')
;
$resolver->setDefined('commit_message_regex')
->setAllowedTypes('commit_message_regex', 'string')
;
$resolver->setDefined('deny_delete_tag')
->setAllowedTypes('deny_delete_tag', 'bool')
->setNormalizer('deny_delete_tag', $booleanNormalizer)
;
$resolver->setDefined('file_name_regex')
->setAllowedTypes('file_name_regex', 'string')
;
$resolver->setDefined('max_file_size')
->setAllowedTypes('max_file_size', 'string')
;
$resolver->setDefined('member_check')
->setAllowedTypes('member_check', 'bool')
->setNormalizer('member_check', $booleanNormalizer)
;
$resolver->setDefined('prevent_secrets')
->setAllowedTypes('prevent_secrets', 'bool')
->setNormalizer('prevent_secrets', $booleanNormalizer)
;
$resolver->setDefined('commit_committer_check')
->setAllowedTypes('commit_committer_check', 'bool')
->setNormalizer('commit_committer_check', $booleanNormalizer)
;
$resolver->setDefined('commit_committer_name_check')
->setAllowedTypes('commit_committer_name_check', 'bool')
->setNormalizer('commit_committer_name_check', $booleanNormalizer)
;
$resolver->setDefined('reject_unsigned_commits')
->setAllowedTypes('reject_unsigned_commits', 'bool')
->setNormalizer('reject_unsigned_commits', $booleanNormalizer)
;
$resolver->setDefined('reject_non_dco_commits')
->setAllowedTypes('reject_non_dco_commits', 'bool')
->setNormalizer('reject_non_dco_commits', $booleanNormalizer)
;

return $this->post($this->getProjectPath($project_id, 'push_rule'), $resolver->resolve($parameters));
}

public function updatePushRule(int|string $project_id, array $parameters = []): mixed
{
$resolver = $this->createOptionsResolver();
$booleanNormalizer = function (Options $resolver, $value): string {
return $value ? 'true' : 'false';
};

$resolver->setDefined('author_email_regex')
->setAllowedTypes('author_email_regex', 'string')
;
$resolver->setDefined('branch_name_regex')
->setAllowedTypes('branch_name_regex', 'string')
;
$resolver->setDefined('commit_message_negative_regex')
->setAllowedTypes('commit_message_negative_regex', 'string')
;
$resolver->setDefined('commit_message_regex')
->setAllowedTypes('commit_message_regex', 'string')
;
$resolver->setDefined('deny_delete_tag')
->setAllowedTypes('deny_delete_tag', 'bool')
->setNormalizer('deny_delete_tag', $booleanNormalizer)
;
$resolver->setDefined('file_name_regex')
->setAllowedTypes('file_name_regex', 'string')
;
$resolver->setDefined('max_file_size')
->setAllowedTypes('max_file_size', 'string')
;
$resolver->setDefined('member_check')
->setAllowedTypes('member_check', 'bool')
->setNormalizer('member_check', $booleanNormalizer)
;
$resolver->setDefined('prevent_secrets')
->setAllowedTypes('prevent_secrets', 'bool')
->setNormalizer('prevent_secrets', $booleanNormalizer)
;
$resolver->setDefined('commit_committer_check')
->setAllowedTypes('commit_committer_check', 'bool')
->setNormalizer('commit_committer_check', $booleanNormalizer)
;
$resolver->setDefined('commit_committer_name_check')
->setAllowedTypes('commit_committer_name_check', 'bool')
->setNormalizer('commit_committer_name_check', $booleanNormalizer)
;
$resolver->setDefined('reject_unsigned_commits')
->setAllowedTypes('reject_unsigned_commits', 'bool')
->setNormalizer('reject_unsigned_commits', $booleanNormalizer)
;
$resolver->setDefined('reject_non_dco_commits')
->setAllowedTypes('reject_non_dco_commits', 'bool')
->setNormalizer('reject_non_dco_commits', $booleanNormalizer)
;

return $this->put($this->getProjectPath($project_id, 'push_rule'), $resolver->resolve($parameters));
}

public function deletePushRule(int|string $project_id): mixed
{
return $this->delete($this->getProjectPath($project_id, 'push_rule'));
}

/**
* @param array $parameters {
*
Expand Down
72 changes: 72 additions & 0 deletions tests/Api/ProjectsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1490,6 +1490,78 @@ public function shouldDeleteDeployToken(): void
$this->assertEquals($expectedBool, $api->deleteDeployToken(1, 2));
}

#[Test]
public function shouldGetPushRule(): void
{
$expectedArray = [
'id' => 1,
'project_id' => 3,
'commit_message_regex' => '.*',
'branch_name_regex' => '.*',
'author_email_regex' => '.*',
];

$api = $this->getApiMock();
$api->expects($this->once())
->method('get')
->with('projects/3/push_rule')
->willReturn($expectedArray);

$this->assertEquals($expectedArray, $api->pushRule(3));
}

#[Test]
public function shouldCreatePushRule(): void
{
$expectedBool = true;
$params = [
'commit_message_regex' => '.*',
'branch_name_regex' => '.*',
'author_email_regex' => '.*',
];

$api = $this->getApiMock();
$api->expects($this->once())
->method('post')
->with('projects/3/push_rule', $params)
->willReturn($expectedBool);

$this->assertEquals($expectedBool, $api->createPushRule(3, $params));
}

#[Test]
public function shouldUpdatePushRule(): void
{
$expectedBool = true;
$params = [
'commit_message_regex' => '.*',
'branch_name_regex' => '.*',
'author_email_regex' => '.*',
];

$api = $this->getApiMock();
$api->expects($this->once())
->method('put')
->with('projects/3/push_rule', $params)
->willReturn($expectedBool);

$this->assertEquals($expectedBool, $api->updatePushRule(3, $params));
}

#[Test]
public function shouldDeletePushRule(): void
{
$expectedBool = true;

$api = $this->getApiMock();
$api->expects($this->once())
->method('delete')
->with('projects/3/push_rule')
->willReturn($expectedBool);

$this->assertEquals($expectedBool, $api->deletePushRule(3));
}

#[Test]
public function shouldGetEvents(): void
{
Expand Down