<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace lib\Accounts;

use InvalidArgumentException;
use OC\Accounts\AccountPropertyCollection;
use OCP\Accounts\IAccountProperty;
use OCP\Accounts\IAccountPropertyCollection;
use PHPUnit\Framework\MockObject\MockObject;
use Test\TestCase;

class AccountPropertyCollectionTest extends TestCase {
	/** @var IAccountPropertyCollection */
	protected $collection;

	protected const COLLECTION_NAME = 'my_multivalue_property';

	public function setUp(): void {
		parent::setUp();

		$this->collection = new AccountPropertyCollection(self::COLLECTION_NAME);
	}

	/**
	 * @return IAccountProperty|MockObject
	 */
	protected function makePropertyMock(string $propertyName): MockObject {
		$mock = $this->createMock(IAccountProperty::class);
		$mock->expects($this->any())
			->method('getName')
			->willReturn($propertyName);

		return $mock;
	}

	public function testSetAndGetProperties(): void {
		$propsBefore = $this->collection->getProperties();
		$this->assertIsArray($propsBefore);
		$this->assertEmpty($propsBefore);

		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
		];

		$this->collection->setProperties($props);
		$propsAfter = $this->collection->getProperties();
		$this->assertIsArray($propsAfter);
		$this->assertCount(count($props), $propsAfter);
	}

	public function testSetPropertiesMixedInvalid(): void {
		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock('sneaky_property'),
			$this->makePropertyMock(self::COLLECTION_NAME),
		];

		$this->expectException(InvalidArgumentException::class);
		$this->collection->setProperties($props);
	}

	public function testAddProperty(): void {
		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
		];
		$this->collection->setProperties($props);

		$additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
		$this->collection->addProperty($additionalProperty);

		$propsAfter = $this->collection->getProperties();
		$this->assertCount(count($props) + 1, $propsAfter);
		$this->assertNotFalse(array_search($additionalProperty, $propsAfter, true));
	}

	public function testAddPropertyInvalid(): void {
		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
		];
		$this->collection->setProperties($props);

		$additionalProperty = $this->makePropertyMock('sneaky_property');
		$exceptionThrown = false;
		try {
			$this->collection->addProperty($additionalProperty);
		} catch (\InvalidArgumentException $e) {
			$exceptionThrown = true;
		} finally {
			$propsAfter = $this->collection->getProperties();
			$this->assertCount(count($props), $propsAfter);
			$this->assertFalse(array_search($additionalProperty, $propsAfter, true));
			$this->assertTrue($exceptionThrown);
		}
	}

	public function testRemoveProperty(): void {
		$additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
			$additionalProperty,
			$this->makePropertyMock(self::COLLECTION_NAME),
		];
		$this->collection->setProperties($props);

		$propsBefore = $this->collection->getProperties();
		$this->collection->removeProperty($additionalProperty);
		$propsAfter = $this->collection->getProperties();

		$this->assertTrue(count($propsBefore) > count($propsAfter));
		$this->assertCount(count($propsBefore) - 1, $propsAfter);
		$this->assertFalse(array_search($additionalProperty, $propsAfter, true));
	}

	public function testRemovePropertyNotFound(): void {
		$additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
		];
		$this->collection->setProperties($props);

		$propsBefore = $this->collection->getProperties();
		$this->collection->removeProperty($additionalProperty);
		$propsAfter = $this->collection->getProperties();

		// no errors, gently
		$this->assertCount(count($propsBefore), $propsAfter);
	}

	public function testRemovePropertyByValue(): void {
		$additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
		$additionalProperty->expects($this->any())
			->method('getValue')
			->willReturn('Lorem ipsum');

		$additionalPropertyTwo = clone $additionalProperty;

		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
			$additionalProperty,
			$this->makePropertyMock(self::COLLECTION_NAME),
			$additionalPropertyTwo
		];
		$this->collection->setProperties($props);

		$propsBefore = $this->collection->getProperties();
		$this->collection->removePropertyByValue('Lorem ipsum');
		$propsAfter = $this->collection->getProperties();

		$this->assertTrue(count($propsBefore) > count($propsAfter));
		$this->assertCount(count($propsBefore) - 2, $propsAfter);
		$this->assertFalse(array_search($additionalProperty, $propsAfter, true));
		$this->assertFalse(array_search($additionalPropertyTwo, $propsAfter, true));
	}

	public function testRemovePropertyByValueNotFound(): void {
		$additionalProperty = $this->makePropertyMock(self::COLLECTION_NAME);
		$additionalProperty->expects($this->any())
			->method('getValue')
			->willReturn('Lorem ipsum');

		$props = [
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
			$this->makePropertyMock(self::COLLECTION_NAME),
		];
		$this->collection->setProperties($props);

		$propsBefore = $this->collection->getProperties();
		$this->collection->removePropertyByValue('Lorem ipsum');
		$propsAfter = $this->collection->getProperties();

		// no errors, gently
		$this->assertCount(count($propsBefore), $propsAfter);
	}
}
'>Vaadin 6, 7, 8 is a Java framework for modern Java web applications: https://github.com/vaadin/framework</td><td class='sub right'>www-data</td></tr></table>
<table class='tabs'><tr><td>
<a href='/vaadin-framework.git/about/?h=JS-RPC-docs-link-syntax'>about</a><a href='/vaadin-framework.git/?h=JS-RPC-docs-link-syntax'>summary</a><a href='/vaadin-framework.git/refs/?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>refs</a><a href='/vaadin-framework.git/log/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc?h=JS-RPC-docs-link-syntax'>log</a><a class='active' href='/vaadin-framework.git/tree/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>tree</a><a href='/vaadin-framework.git/commit/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>commit</a><a href='/vaadin-framework.git/diff/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>diff</a><a href='/vaadin-framework.git/stats/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc?h=JS-RPC-docs-link-syntax'>stats</a></td><td class='form'><form class='right' method='get' action='/vaadin-framework.git/log/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc'>
<input type='hidden' name='h' value='JS-RPC-docs-link-syntax'/><input type='hidden' name='id' value='ce3575500883820c16bbb53363a3d6dca5c4a6fb'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/vaadin-framework.git/tree/?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>root</a>/<a href='/vaadin-framework.git/tree/documentation?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>documentation</a>/<a href='/vaadin-framework.git/tree/documentation/sqlcontainer?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>sqlcontainer</a>/<a href='/vaadin-framework.git/tree/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>sqlcontainer-getting-started.asciidoc</a></div><div class='content'>blob: acecb4dc5e8fd88218aa90903fac6019d9e8e3c0 (<a href='/vaadin-framework.git/plain/documentation/sqlcontainer/sqlcontainer-getting-started.asciidoc?h=JS-RPC-docs-link-syntax&amp;id=ce3575500883820c16bbb53363a3d6dca5c4a6fb'>plain</a>)
<table summary='blob content' class='blob'>
<tr><td class='linenumbers'><pre><a id='n1' href='#n1'>1</a>
<a id='n2' href='#n2'>2</a>
<a id='n3' href='#n3'>3</a>
<a id='n4' href='#n4'>4</a>
<a id='n5' href='#n5'>5</a>
<a id='n6' href='#n6'>6</a>
<a id='n7' href='#n7'>7</a>
<a id='n8' href='#n8'>8</a>
<a id='n9' href='#n9'>9</a>
<a id='n10' href='#n10'>10</a>
<a id='n11' href='#n11'>11</a>
<a id='n12' href='#n12'>12</a>
<a id='n13' href='#n13'>13</a>
<a id='n14' href='#n14'>14</a>
<a id='n15' href='#n15'>15</a>
<a id='n16' href='#n16'>16</a>
<a id='n17' href='#n17'>17</a>
<a id='n18' href='#n18'>18</a>
<a id='n19' href='#n19'>19</a>
<a id='n20' href='#n20'>20</a>
<a id='n21' href='#n21'>21</a>
<a id='n22' href='#n22'>22</a>
<a id='n23' href='#n23'>23</a>
<a id='n24' href='#n24'>24</a>
<a id='n25' href='#n25'>25</a>
<a id='n26' href='#n26'>26</a>
<a id='n27' href='#n27'>27</a>
<a id='n28' href='#n28'>28</a>
<a id='n29' href='#n29'>29</a>
<a id='n30' href='#n30'>30</a>
<a id='n31' href='#n31'>31</a>
<a id='n32' href='#n32'>32</a>
<a id='n33' href='#n33'>33</a>
<a id='n34' href='#n34'>34</a>
<a id='n35' href='#n35'>35</a>
<a id='n36' href='#n36'>36</a>
<a id='n37' href='#n37'>37</a>
<a id='n38' href='#n38'>38</a>
<a id='n39' href='#n39'>39</a>
<a id='n40' href='#n40'>40</a>
<a id='n41' href='#n41'>41</a>
<a id='n42' href='#n42'>42</a>
<a id='n43' href='#n43'>43</a>
<a id='n44' href='#n44'>44</a>
<a id='n45' href='#n45'>45</a>
<a id='n46' href='#n46'>46</a>
<a id='n47' href='#n47'>47</a>
<a id='n48' href='#n48'>48</a>
<a id='n49' href='#n49'>49</a>
<a id='n50' href='#n50'>50</a>
<a id='n51' href='#n51'>51</a>
<a id='n52' href='#n52'>52</a>
<a id='n53' href='#n53'>53</a>
<a id='n54' href='#n54'>54</a>
<a id='n55' href='#n55'>55</a>
<a id='n56' href='#n56'>56</a>
<a id='n57' href='#n57'>57</a>
<a id='n58' href='#n58'>58</a>
<a id='n59' href='#n59'>59</a>
<a id='n60' href='#n60'>60</a>
<a id='n61' href='#n61'>61</a>
<a id='n62' href='#n62'>62</a>
<a id='n63' href='#n63'>63</a>
<a id='n64' href='#n64'>64</a>
<a id='n65' href='#n65'>65</a>
<a id='n66' href='#n66'>66</a>
<a id='n67' href='#n67'>67</a>
<a id='n68' href='#n68'>68</a>
<a id='n69' href='#n69'>69</a>
<a id='n70' href='#n70'>70</a>
<a id='n71' href='#n71'>71</a>
<a id='n72' href='#n72'>72</a>
<a id='n73' href='#n73'>73</a>
<a id='n74' href='#n74'>74</a>
<a id='n75' href='#n75'>75</a>
<a id='n76' href='#n76'>76</a>
<a id='n77' href='#n77'>77</a>
<a id='n78' href='#n78'>78</a>
<a id='n79' href='#n79'>79</a>
<a id='n80' href='#n80'>80</a>
<a id='n81' href='#n81'>81</a>
<a id='n82' href='#n82'>82</a>
<a id='n83' href='#n83'>83</a>
<a id='n84' href='#n84'>84</a>
<a id='n85' href='#n85'>85</a>
</pre></td>
<td class='lines'><pre><code><style>pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span>---
title: Getting Started with SQLContainer
order: 2
layout: page
---

[[sqlcontainer.getting-started]]
= Getting Started with SQLContainer

Getting development going with the SQLContainer is easy and quite
straight-forward. The purpose of this section is to describe how to create the
required resources and how to fetch data from and write data to a database table
attached to the container.

[[sqlcontainer.getting-started.connection-pool]]
== Creating a connection pool

First, we need to create a connection pool to allow the SQLContainer to connect
to a database. Here we will use the [classname]#SimpleJDBCConnectionPool#, which
is a basic implementation of connection pooling with JDBC data sources. In the
following code, we create a connection pool that uses the HSQLDB driver together
with an in-memory database. The initial amount of connections is 2 and the
maximum amount is set at 5. Note that the database driver, connection url,
username, and password parameters will vary depending on the database you are
using.


----
JDBCConnectionPool pool = new SimpleJDBCConnectionPool(
        &quot;org.hsqldb.jdbc.JDBCDriver&quot;,
        &quot;jdbc:hsqldb:mem:sqlcontainer&quot;, &quot;SA&quot;, &quot;&quot;, 2, 5);
----


[[sqlcontainer.getting-started.query-delegate]]
== Creating the [classname]#TableQuery# Query Delegate

After the connection pool is created, we&#39;ll need a query delegate for the
SQLContainer. The simplest way to create one is by using the built-in
[classname]#TableQuery# class. The [classname]#TableQuery# delegate provides
access to a defined database table and supports reading and writing data
out-of-the-box. The primary key(s) of the table may be anything that the
database engine supports, and are found automatically by querying the database
when a new [classname]#TableQuery# is instantiated. We create the
[classname]#TableQuery# with the following statement:


----
TableQuery tq = new TableQuery(&quot;tablename&quot;, connectionPool);
----

In order to allow writes from several user sessions concurrently, we must set a
version column to the [classname]#TableQuery# as well. The version column is an
integer- or timestamp-typed column which will either be incremented or set to
the current time on each modification of the row. [classname]#TableQuery#
assumes that the database will take care of updating the version column; it just
makes sure the column value is correct before updating a row. If another user
has changed the row and the version number in the database does not match the
version number in memory, an [classname]#OptimisticLockException# is thrown and
you can recover by refreshing the container and allow the user to merge the
data. The following code will set the version column:


----
tq.setVersionColumn(&quot;OPTLOCK&quot;);
----


[[sqlcontainer.getting-started.container-creation]]
== Creating the Container

Finally, we may create the container itself. This is as simple as stating:


----
SQLContainer container = new SQLContainer(tq);
----

After this statement, the [classname]#SQLContainer# is connected to the table
tablename and is ready to use for example as a data source for a Vaadin
[classname]#Table# or a Vaadin [classname]#Form#.
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.zx2c4.com/cgit/about/'>cgit v1.2.3</a> (<a href='https://git-scm.com/'>git 2.39.1</a>) at 2025-07-23 19:02:24 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>
