Skip to content

Maintenance – Merge pr #59 && add integration test #129

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
derpixler wants to merge 1 commit into
base: master
Choose a base branch
from
+170 −3
Open

Maintenance – Merge pr #59 && add integration test #129

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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ Additionally you can have a look at the REST interface documentation of Zammad:
* [Ticket priorities](https://docs.zammad.org/en/latest/api/ticket-priority.html)
* [Ticket states](https://docs.zammad.org/en/latest/api/ticket-state.html)
* [Tags](https://docs.zammad.org/en/latest/api/tags.html)
* [Linking Tickets](https://docs.zammad.org/en/latest/api/ticket/links.html)
* [Tag list](https://docs.zammad.org/en/latest/api/ticket/tags.html#administration-scope)
* [Linking Tickets](https://docs.zammad.org/en/latest/api/ticket/links.html)

#### Fetching a ticket's articles
If you already have a ticket object, you can easily fetch its articles:
Expand Down Expand Up @@ -325,7 +326,7 @@ $client->resource( ResourceType::TICKET );
| ORGANIZATION|✔|✔|✔|✔|✔|–|–|✔|
| GROUP|✔|✔|–|✔|✔|–|–|–|
| USER|✔|✔|✔|✔|✔|–|–|✔|
| TAG|✔|–|✔|–|–|✔|✔|–|
| TAG|✔|✔|✔|✔|✔|✔|✔|–|
| LINK|✔|–|–|–|–|✔|✔|–|

## Publishing
Expand Down
6 changes: 5 additions & 1 deletion src/Resource/Tag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ class Tag extends AbstractResource
'get' => 'tags',
'search' => 'tag_search?term={query}',
'add' => 'tags/add',
'remove' => 'tags/remove'
'remove' => 'tags/remove',
'all' => 'tag_list',
'create' => 'tag_list',
'update' => 'tag_list/{object_id}',
'delete' => 'tag_list/{object_id}',
];

/**
Expand Down
162 changes: 162 additions & 0 deletions test/ZammadAPIClient/Resource/TagTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,168 @@ public function testRemove()
);
}

public function testAdminAll()
{
$tags = self::getClient()->resource( $this->resource_type )->all();

$this->assertIsArray(
$tags,
'all() must return an array.'
);

if ( count($tags) > 0 ) {
$tag = $tags[0];
$this->assertInstanceOf(
$this->resource_type,
$tag,
'Elements must be Tag instances.'
);
$this->assertNotNull(
$tag->getValue('id'),
'Tag must have an id field.'
);
$this->assertNotNull(
$tag->getValue('name'),
'Tag must have a name field.'
);
}
}

public function testAdminCreate()
{
$tag_name = self::getUniqueID();

$tag = self::getClient()->resource( $this->resource_type );
$tag->setValue('name', $tag_name);
$saved_tag = $tag->save();

$this->assertFalse(
$saved_tag->hasError(),
'Error must not be set after creating tag.'
);

$tags = self::getClient()->resource( $this->resource_type )->all();
$found = false;
foreach ( $tags as $t ) {
if ( $t->getValue('name') === $tag_name ) {
$found = true;
break;
}
}

$this->assertTrue(
$found,
'Created tag must appear in all().'
);
}

public function testAdminUpdate()
{
$tag_name = self::getUniqueID();

$tag = self::getClient()->resource( $this->resource_type );
$tag->setValue('name', $tag_name);
$tag->save();

$this->assertFalse(
$tag->hasError(),
'Error must not be set after creating tag for update.'
);

$tags = self::getClient()->resource( $this->resource_type )->all();
$found_tag = null;
foreach ( $tags as $t ) {
if ( $t->getValue('name') === $tag_name ) {
$found_tag = $t;
break;
}
}

$this->assertNotNull(
$found_tag,
'Created tag must be found in all().'
);

$new_name = $tag_name . '_updated';
$found_tag->setValue('name', $new_name);
$found_tag->save();

$this->assertFalse(
$found_tag->hasError(),
'Error must not be set after updating tag.'
);

$tags = self::getClient()->resource( $this->resource_type )->all();
$found_updated = false;
$found_old = false;
foreach ( $tags as $t ) {
if ( $t->getValue('name') === $new_name ) {
$found_updated = true;
}
if ( $t->getValue('name') === $tag_name ) {
$found_old = true;
}
}

$this->assertTrue(
$found_updated,
'Updated tag name must appear in all().'
);
$this->assertFalse(
$found_old,
'Old tag name must not appear in all().'
);
}

public function testAdminDelete()
{
$tag_name = self::getUniqueID();

$tag = self::getClient()->resource( $this->resource_type );
$tag->setValue('name', $tag_name);
$tag->save();

$this->assertFalse(
$tag->hasError(),
'Error must not be set after creating tag for delete.'
);

$tags = self::getClient()->resource( $this->resource_type )->all();
$found_tag = null;
foreach ( $tags as $t ) {
if ( $t->getValue('name') === $tag_name ) {
$found_tag = $t;
break;
}
}

$this->assertNotNull(
$found_tag,
'Created tag must be found in all() before delete.'
);

$found_tag->delete();

$this->assertFalse(
$found_tag->hasError(),
'Error must not be set after deleting tag.'
);

$tags = self::getClient()->resource( $this->resource_type )->all();
$found = false;
foreach ( $tags as $t ) {
if ( $t->getValue('name') === $tag_name ) {
$found = true;
break;
}
}

$this->assertFalse(
$found,
'Deleted tag must not appear in all().'
);
}

private static function createTicket()
{
self::$ticket = self::getClient()->resource( ResourceType::TICKET );
Expand Down