From 92e5fb4053eaa27984db6f6ddb7eaf028a46525b Mon Sep 17 00:00:00 2001
From: Joas Schilling <coding@schilljs.com>
Date: Wed, 9 Nov 2016 10:08:29 +0100
Subject: [PATCH] Add tests for validity of the definitions

Signed-off-by: Joas Schilling <coding@schilljs.com>
---
 .../lib/RichObjectStrings/DefinitionsTest.php | 84 +++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 tests/lib/RichObjectStrings/DefinitionsTest.php

diff --git a/tests/lib/RichObjectStrings/DefinitionsTest.php b/tests/lib/RichObjectStrings/DefinitionsTest.php
new file mode 100644
index 0000000000..e226ffcd3f
--- /dev/null
+++ b/tests/lib/RichObjectStrings/DefinitionsTest.php
@@ -0,0 +1,84 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 Test\RichObjectStrings;
+
+
+use OCP\RichObjectStrings\Definitions;
+use Test\TestCase;
+
+class DefinitionsTest extends TestCase {
+
+	public function dataGetDefinition() {
+		$definitions = new Definitions();
+		$testsuite = [];
+		foreach ($definitions->definitions as $type => $definition) {
+			$testsuite[] = [$type, $definition];
+		}
+		return $testsuite;
+	}
+
+	/**
+	 * @dataProvider dataGetDefinition
+	 * @param string $type
+	 * @param array $expected
+	 */
+	public function testGetDefinition($type, array $expected) {
+		$definitions = new Definitions();
+		$definition = $definitions->getDefinition($type);
+
+		$this->assertEquals($expected, $definition);
+		$this->assertArrayHasKey('author', $definition);
+		$this->assertNotEquals('', $definition['author'], 'Author of definition must not be empty');
+		$this->assertArrayHasKey('app', $definition);
+		$this->assertNotEquals('', $definition['app'], 'App of definition must not be empty');
+		$this->assertArrayHasKey('since', $definition);
+		$this->assertNotEmpty($definition['since'], 'Since of definition must not be empty');
+		$this->assertArrayHasKey('parameters', $definition);
+		$this->assertTrue(is_array($definition['parameters']), 'Parameters of definition must be of type array');
+		$this->assertNotEmpty($definition['parameters'], 'Parameters of definition must not be empty');
+
+
+		$this->assertArrayHasKey('id', $definition['parameters'], 'Parameter ID must be defined');
+		$this->assertArrayHasKey('name', $definition['parameters'], 'Parameter name must be defined');
+
+		foreach ($definition['parameters'] as $parameter => $data) {
+			$this->validateParameter($parameter, $data);
+		}
+	}
+
+	public function validateParameter($parameter, $data) {
+		$this->assertTrue(is_array($data), 'Parameter ' . $parameter . ' is invalid');
+		$this->assertArrayHasKey('since', $data);
+		$this->assertNotEmpty($data['since'], 'Since of parameter ' . $parameter . ' must not be empty');
+		$this->assertArrayHasKey('required', $data);
+		$this->assertTrue(is_bool($data['required']), 'Required of parameter ' . $parameter . ' must be a boolean');
+		if ($parameter === 'id' || $parameter === 'name') {
+			$this->assertTrue($data['required'], 'Parameter ' . $parameter . ' must be required');
+		}
+
+		$this->assertArrayHasKey('description', $data);
+		$this->assertNotEquals('', $data['description'], 'Description of parameter ' . $parameter . ' must not be empty');
+		$this->assertArrayHasKey('example', $data);
+		$this->assertNotEquals('', $data['example'], 'Example of parameter ' . $parameter . ' must not be empty');
+
+	}
+}