File: EMailTest.php

package info (click to toggle)
simplesamlphp 1.19.7-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 42,920 kB
  • sloc: php: 202,044; javascript: 14,867; xml: 2,700; sh: 225; perl: 82; makefile: 70; python: 5
file content (157 lines) | stat: -rw-r--r-- 4,800 bytes parent folder | download | duplicates (3)
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
<?php

declare(strict_types=1);

namespace SimpleSAML\Test\Utils;

use Exception;
use InvalidArgumentException;
use SimpleSAML\Configuration;
use SimpleSAML\Test\Utils\TestCase;
use SimpleSAML\Utils\EMail;

/**
 * A base SSP test case that tests some simple e-mail related calls
 */
class EMailTest extends ClearStateTestCase
{
    /**
     * @return void
     */
    public function setUp()
    {
        parent::setUp();

        // Override configuration
        Configuration::loadFromArray([
            'technicalcontact_email' => 'na@example.org',
        ], '[ARRAY]', 'simplesaml');
    }


    /**
     * Test that an exception is thrown if using default configuration,
     * and no custom from address is specified.
     * @return void
     */
    public function testMailFromDefaultConfigurationException(): void
    {
        $this->expectException(Exception::class);
        new EMail('test', null, 'phpunit@simplesamlphp.org');
    }


    /**
     * Test that an exception is thrown if using an invalid "From"-address
     * @return void
     */
    public function testInvalidFromAddressException(): void
    {
        $this->expectException(Exception::class);
        new EMail('test', "phpunit@simplesamlphp.org\nLorem Ipsum", 'phpunit@simplesamlphp.org');
    }


    /**
     * Test that an exception is thrown if using an invalid "To"-address
     * @return void
     */
    public function testInvalidToAddressException(): void
    {
        $this->expectException(Exception::class);
        new EMail('test', 'phpunit@simplesamlphp.org', "phpunit@simplesamlphp.org\nLorem Ipsum");
    }


    /**
     * Test that the data given is visible in the resulting mail
     * @dataProvider mailTemplates
     * @param string $template
     * @return void
     */
    public function testMailContents($template): void
    {
        $mail = new EMail(
            'subject-subject-subject-subject-subject-subject-subject',
            'phpunit@simplesamlphp.org',
            'phpunit@simplesamlphp.org'
        );
        $mail->setText('text-text-text-text-text-text-text');
        $mail->setData(['key-key-key-key-key-key-key' => 'value-value-value-value-value-value-value']);
        $result = $mail->generateBody($template);
        $this->assertRegexp('/(subject-){6}/', $result);
        $this->assertRegexp('/(text-){6}/', $result);
        $this->assertRegexp('/(key-){6}/', $result);
        $this->assertRegexp('/(value-){6}/', $result);
    }


    /**
     * All templates that should be tested in #testMailContents($template)
     * @return array
     */
    public static function mailTemplates(): array
    {
        return [['mailtxt.twig'], ['mailhtml.twig']];
    }


    /**
     * @return void
     */
    public function testInvalidTransportConfiguration(): void
    {
        // preserve the original configuration
        $originalTestConfiguration = Configuration::getInstance()->toArray();

        // load the configuration with an invalid mail.transport.method
        Configuration::loadFromArray(array_merge($originalTestConfiguration, [
            'mail.transport.method' => 'foobar'
        ]), '[ARRAY]', 'simplesaml');


        $this->expectException(InvalidArgumentException::class);
        new Email('Test', 'phpunit@simplesamlphp.org', 'phpunit@simplesamlphp.org');

        // reset the configuration
        Configuration::loadFromArray($originalTestConfiguration, '[ARRAY]', 'simplesaml');
    }


    /**
     * @return void
     */
    public function testInvalidSMTPConfiguration(): void
    {
        // setup a new email
        $email = new Email('Test', 'phpunit@simplesamlphp.org', 'phpunit@simplesamlphp.org');

        // set the transport option to smtp but don't set any transport options (invalid state)
        // NOTE: this is the same method that the constructor calls, so this should be logically equivalent
        // to setting it via the configuration file.
        $this->expectException(InvalidArgumentException::class);
        $email->setTransportMethod('smtp');
    }

    /**
     * Test setting configuration.
     *
     * @return void
     */
    public function testGetDefaultMailAddress(): void
    {
        Configuration::loadFromArray([
            'technicalcontact_email' => 'gamaarna@example.org',
        ], '[ARRAY]', 'simplesaml');

        $mail = new EMail('test', null, 'phpunit@simplesamlphp.org');
        $this->assertEquals('gamaarna@example.org', $mail->getDefaultMailAddress());

        Configuration::loadFromArray([
            'technicalcontact_email' => 'mailto:gamaarna@example.org',
        ], '[ARRAY]', 'simplesaml');

        $mail = new EMail('test', null, 'phpunit@simplesamlphp.org');
        $this->assertEquals('gamaarna@example.org', $mail->getDefaultMailAddress());
    }
}