aboutsummaryrefslogtreecommitdiffstats
path: root/apps/theming/tests/Themes/AccessibleThemeTestCase.php
blob: 84121dd41b0b93663c77a5fa84d8a3dd0d3d93fc (plain)
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
<?php
/**
 * @copyright Copyright (c) 2023 Ferdinand Thiessen <opensource@fthiessen.de>
 *
 * @author Ferdinand Thiessen <opensource@fthiessen.de>
 *
 * @license AGPL-3.0-or-later
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\Theming\Tests\Themes;

use OCA\Theming\ITheme;
use OCA\Theming\Util;
use Test\TestCase;

class AccessibleThemeTestCase extends TestCase {
	protected ITheme $theme;
	protected Util $util;

	/**
	 * Set to true to check for WCAG AAA level accessibility
	 */
	protected bool $WCAGaaa = false;

	public function dataAccessibilityPairs() {
		$textContrast = $this->WCAGaaa ? 7.0 : 4.5;
		$elementContrast = 3.0;

		return [
			'primary-element on background' => [
				[
					'--color-primary-element',
					'--color-primary-element-hover',
				],
				[
					'--color-main-background',
					'--color-background-hover',
					'--color-background-dark',
					'--color-background-darker',
					'--color-main-background-blur',
				],
				$elementContrast,
			],
			'status color elements on background' => [
				[
					'--color-error',
					'--color-error-hover',
					'--color-warning',
					'--color-warning-hover',
					'--color-info',
					'--color-info-hover',
					'--color-success',
					'--color-success-hover',
				],
				[
					'--color-main-background',
					'--color-background-hover',
					'--color-background-dark',
					'--color-background-darker',
					'--color-main-background-blur',
				],
				$elementContrast,
			],
			// Those two colors are used for borders which will be `color-main-text` on focussed state, thus need 3:1 contrast to it
			'success-error-border-colors' => [
				[
					'--color-error',
					'--color-success',
				],
				[
					'--color-main-text',
				],
				$elementContrast,
			],
			'primary-element-text' => [
				[
					'--color-primary-element-text',
					'--color-primary-element-text-dark',
				],
				[
					'--color-primary-element',
					'--color-primary-element-hover',
				],
				$textContrast,
			],
			'primary-element-light-text' => [
				['--color-primary-element-light-text'],
				[
					'--color-primary-element-light',
					'--color-primary-element-light-hover',
				],
				$textContrast,
			],
			'main-text' => [
				['--color-main-text'],
				[
					'--color-main-background',
					'--color-background-hover',
					'--color-background-dark',
					'--color-background-darker',
					'--color-main-background-blur',
				],
				$textContrast,
			],
			'max-contrast-text' => [
				['--color-text-maxcontrast'],
				[
					'--color-main-background',
					'--color-background-hover',
					'--color-background-dark',
				],
				$textContrast,
			],
			'max-contrast text-on blur' => [
				['--color-text-maxcontrast-background-blur'],
				[
					'--color-main-background-blur',
				],
				$textContrast,
			],
			'status-text' => [
				[
					'--color-error-text',
					'--color-warning-text',
					'--color-success-text',
					'--color-info-text',
				],
				[
					'--color-main-background',
					'--color-background-hover',
					'--color-background-dark',
					'--color-main-background-blur',
				],
				$textContrast,
			],
		];
	}

	/**
	 * @dataProvider dataAccessibilityPairs
	 */
	public function testAccessibilityOfVariables($mainColors, $backgroundColors, $minContrast) {
		if (!isset($this->theme)) {
			$this->markTestSkipped('You need to setup $this->theme in your setUp function');
		} elseif (!isset($this->util)) {
			$this->markTestSkipped('You need to setup $this->util in your setUp function');
		}

		$variables = $this->theme->getCSSVariables();

		// Blur effect does not work so we mockup the color - worst supported case is the default "clouds" background image (on dark themes the clouds with white color are bad on bright themes the primary color as sky is bad)
		$variables['--color-main-background-blur'] = $this->util->mix($variables['--color-main-background'], $this->util->isBrightColor($variables['--color-main-background']) ? '#000000' : '#ffffff', 75);

		foreach ($backgroundColors as $background) {
			$this->assertStringStartsWith('#', $variables[$background], 'Is not a plain color variable - consider to remove or fix this test');
			foreach ($mainColors as $main) {
				$this->assertStringStartsWith('#', $variables[$main], 'Is not a plain color variable - consider to remove or fix this test');
				$realContrast = $this->util->colorContrast($variables[$main], $variables[$background]);
				$this->assertGreaterThanOrEqual($minContrast, $realContrast, "Contrast is not high enough for $main (" . $variables[$main] . ") on $background (" . $variables[$background] . ')');
			}
		}
	}
}