File: GrowlNotifyTaskTest.php

package info (click to toggle)
phing 3.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,368 kB
  • sloc: php: 59,821; xml: 9,767; sql: 78; makefile: 39; sh: 14
file content (220 lines) | stat: -rw-r--r-- 6,998 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<?php

/**
 * Copyright (c) 2012-2013, Laurent Laville <pear@laurent-laville.org>.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the authors nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP version 5
 *
 * @category   Tasks
 *
 * @author     Laurent Laville <pear@laurent-laville.org>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @see       https://github.com/llaville/phing-GrowlNotifyTask
 */

namespace Phing\Test\Task\Optional;

use Net_Growl;
use Phing\Exception\BuildException;
use Phing\Project;
use Phing\Task\Ext\GrowlNotifyTask;
use Phing\Test\Support\BuildFileTest;

/**
 * Tests for GrowlNotifyTask.
 *
 * @category   Tasks
 *
 * @author     Laurent Laville <pear@laurent-laville.org>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @see       https://github.com/llaville/phing-GrowlNotifyTask
 *
 * @internal
 */
class GrowlNotifyTaskTest extends BuildFileTest
{
    /**
     * Mock task's instance.
     *
     * @var object
     */
    protected $mockTask;

    /**
     * Sets up the fixture.
     */
    public function setUp(): void
    {
        if (!class_exists('Net_Growl')) {
            $this->markTestSkipped('Need Net_Growl installed to test');

            return;
        }

        $this->configureProject(PHING_TEST_BASE . '/etc/tasks/ext/growl/build.xml');

        $name = '';

        $gntpMock = Net_Growl::singleton(
            $name,
            [],
            '',
            ['protocol' => 'gntpMock']
        );
        $gntpMock->addResponse(
            "GNTP/1.0 -OK NONE\r\n" .
            "Response-Action: REGISTER\r\n" .
            ''
        );
        $gntpMock->addResponse(
            "GNTP/1.0 -OK NONE\r\n" .
            "Response-Action: NOTIFY\r\n" .
            ''
        );
        $this->mockTask = new GrowlNotifyTask($gntpMock);
        $this->mockTask->setProject($this->project);
        $targets = $this->project->getTargets();
        $targets['test']->addTask($this->mockTask);
        $this->mockTask->setOwningTarget($targets['test']);
    }

    /**
     * Test for required message attribute.
     */
    public function testEmptyMessage(): void
    {
        $this->expectException(BuildException::class);
        $this->expectExceptionMessage('"message" attribute cannot be empty');

        $this->executeTarget(__FUNCTION__);
    }

    /**
     * Test a single message notification.
     */
    public function testSingleNotification(): void
    {
        $this->mockTask->setMessage('Single test message.');

        $this->executeTarget('test');
        $this->assertInLogs('Notification-Text: Single test message.');
    }

    /**
     * Test a single message notification that sould be sticky.
     */
    public function testSingleStickyNotification(): void
    {
        $this->mockTask->setMessage('Sticky message !!!');
        $this->mockTask->setSticky('true');

        $this->executeTarget('test');
        $this->assertInLogs('Notification-Sticky: 1', Project::MSG_DEBUG);
    }

    /**
     * Test a single notification with custom application icon.
     */
    public function testSingleCustomAppIconNotification(): void
    {
        $this->mockTask->setMessage('Test with custom Application Icon.');
        $this->mockTask->setAppicon('..\..\..\..\data\Help.ico');

        $this->executeTarget('test');
        $this->assertInLogs('Application-Icon:', Project::MSG_DEBUG);
    }

    /**
     * Test a single notification with custom notification type.
     */
    public function testSingleNotificationType(): void
    {
        $this->mockTask->setMessage('Build FINISHED.');
        $this->mockTask->setNotification('Status');

        $this->executeTarget('test');
        $this->assertInLogs('Notification-Name: Status', Project::MSG_DEBUG);
    }

    /**
     * Test a single notification with custom title.
     */
    public function testSingleNotificationTitled(): void
    {
        $this->mockTask->setMessage('Build FAILED.');
        $this->mockTask->setTitle('PhingNotify');

        $this->executeTarget('test');
        $this->assertInLogs('Notification-Title: PhingNotify', Project::MSG_DEBUG);
    }

    /**
     * Test broadcasting message.
     */
    public function testBroadcastNotification(): void
    {
        $this->mockTask->setMessage('Broadcast message : Build FAILED.');
        $this->mockTask->setHost('192.168.1.2');

        $this->executeTarget('test');
        $this->assertInLogs('Notification was sent to remote host 192.168.1.2');
    }

    /**
     * Test a single notification with priority defined.
     */
    public function testSingleNotificationWithPriority(): void
    {
        $this->mockTask->setMessage('Build DEPLOYED.');
        $this->mockTask->setPriority('high');

        $this->executeTarget('test');
        $this->assertInLogs(
            'Notification-Priority: ' . Net_Growl::PRIORITY_HIGH,
            Project::MSG_DEBUG
        );
    }

    /**
     * Test a single notification with custom application and message icons.
     */
    public function testSingleCustomIconNotification(): void
    {
        $this->mockTask->setMessage('Custom Application and Icon message.');
        $this->mockTask->setAppicon('..\..\..\..\data\Help.ico');
        $this->mockTask->setIcon('..\..\..\..\data\warning.png');

        $this->executeTarget('test');
        $this->assertInLogs('Application-Icon:', Project::MSG_DEBUG);
        $this->assertInLogs('Notification-Icon:', Project::MSG_DEBUG);
    }
}