Add a new \SimpleSAML\Utils\Attributes class.

2 files changed, 158 insertions, 0 deletions

diff --git a/lib/SimpleSAML/Utils/Attributes.php b/lib/SimpleSAML/Utils/Attributes.php
new file mode 100644
index 0000000..6f67bac
--- /dev/null
+++ b/lib/SimpleSAML/Utils/Attributes.php
@@ -0,0 +1,57 @@
+<?php
+namespace SimpleSAML\Utils;
+
+/**
+ * Attribute-related utility methods.
+ *
+ * @author Jaime Perez, UNINETT AS <jaime.perez@uninett.no>
+ * @package SimpleSAML
+ */
+class Attributes
+{
+
+    /**
+     * Look for an attribute in a normalized attributes array, failing if it's not there.
+     *
+     * @param array $attributes The normalized array containing attributes.
+     * @param string $expected The name of the attribute we are looking for.
+     * @param bool $allow_multiple Whether to allow multiple values in the attribute or not.
+     *
+     * @return mixed The value of the attribute we are expecting. If the attribute has multiple values and
+     * $allow_multiple is set to true, the first value will be returned.
+     *
+     * @throws \InvalidArgumentException If $attributes is not an array or $expected is not a string.
+     * @throws \SimpleSAML_Error_Exception If the expected attribute was not found in the attributes array.
+     */
+    public static function getExpectedAttribute($attributes, $expected, $allow_multiple = false)
+    {
+        if (!is_array($attributes)) {
+            throw new \InvalidArgumentException(
+                'The attributes array is not an array, it is: '.print_r($attributes, true).'.'
+            );
+        }
+
+        if (!is_string($expected)) {
+            throw new \InvalidArgumentException(
+                'The expected attribute is not a string, it is: '.print_r($expected, true).'.'
+            );
+        }
+
+        if (!array_key_exists($expected, $attributes)) {
+            throw new \SimpleSAML_Error_Exception("No such attribute '".$expected."' found.");
+        }
+        $attribute = $attributes[$expected];
+
+        if (!is_array($attribute)) {
+            throw new \SimpleSAML_Error_Exception('The attributes array is not normalized, values should be arrays.');
+        }
+        if (count($attribute) > 1) {
+            if ($allow_multiple === false) {
+                throw new \SimpleSAML_Error_Exception(
+                    'More than one value found for the attribute, multiple values not allowed.'
+                );
+            }
+        }
+        return reset($attribute);
+    }
+}
diff --git a/tests/lib/SimpleSAML/Utils/AttributesTest.php b/tests/lib/SimpleSAML/Utils/AttributesTest.php
new file mode 100644
index 0000000..1960de0
--- /dev/null
+++ b/tests/lib/SimpleSAML/Utils/AttributesTest.php
@@ -0,0 +1,101 @@
+<?php
+
+
+/**
+ * Tests for SimpleSAML\Utils\Attributes.
+ *
+ * @author Jaime Perez, UNINETT AS <jaime.perez@uninett.no>
+ */
+class Utils_AttributesTest extends PHPUnit_Framework_TestCase
+{
+
+    /**
+     * Test the getExpectedAttribute() function with invalid input.
+     */
+    public function testGetExpectedAttributeInvalidInput()
+    {
+        // check with empty array as input
+        $attributes = 'string';
+        $expected = 'string';
+        $this->setExpectedException(
+            'InvalidArgumentException',
+            'The attributes array is not an array, it is: '.print_r($attributes, true).'.'
+        );
+        \SimpleSAML\Utils\Attributes::getExpectedAttribute($attributes, $expected);
+
+        // check with invalid attribute name
+        $attributes = array();
+        $expected = false;
+        $this->setExpectedException(
+            'InvalidArgumentException',
+            'The expected attribute is not a string, it is: '.print_r($expected, true).'.'
+        );
+        \SimpleSAML\Utils\Attributes::getExpectedAttribute($attributes, $expected);
+
+        // check with non-normalized attributes array
+        $attributes = array(
+            'attribute' => 'value',
+        );
+        $expected = 'attribute';
+        $this->setExpectedException(
+            'InvalidArgumentException',
+            'The attributes array is not normalized, values should be arrays.'
+        );
+        \SimpleSAML\Utils\Attributes::getExpectedAttribute($attributes, $expected);
+    }
+
+
+    /**
+     * Test the getExpectedAttribute() with valid input that raises exceptions.
+     */
+    public function testGetExpectedAttributeErrorConditions()
+    {
+        // check missing attribute
+        $attributes = array(
+            'attribute' => array('value'),
+        );
+        $expected = 'missing';
+        $this->setExpectedException(
+            'SimpleSAML_Error_Exception',
+            "No such attribute '".$expected."' found."
+        );
+        \SimpleSAML\Utils\Attributes::getExpectedAttribute($attributes, $expected);
+
+        // check attribute with more than value, that being not allowed
+        $attributes = array(
+            'attribute' => array(
+                'value1',
+                'value2',
+            ),
+        );
+        $expected = 'attribute';
+        $this->setExpectedException(
+            'SimpleSAML_Error_Exception',
+            'More than one value found for the attribute, multiple values not allowed.'
+        );
+        \SimpleSAML\Utils\Attributes::getExpectedAttribute($attributes, $expected);
+    }
+
+
+    /**
+     * Test that the getExpectedAttribute() method successfully obtains values from the attributes array.
+     */
+    public function testGetExpectedAttribute()
+    {
+        // check one value
+        $value = 'value';
+        $attributes = array(
+            'attribute' => array($value),
+        );
+        $expected = 'attribute';
+        $this->assertEquals($value, \SimpleSAML\Utils\Attributes::getExpectedAttribute($attributes, $expected));
+
+        // check multiple (allowed) values
+        $value = 'value';
+        $attributes = array(
+            'attribute' => array($value, 'value2', 'value3'),
+        );
+        $expected = 'attribute';
+        $this->assertEquals($value, \SimpleSAML\Utils\Attributes::getExpectedAttribute($attributes, $expected, true));
+    }
+}