nextcloud-server/apps/files_external/tests/Storage/SftpTest.php

<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCA\Files_External\Tests\Storage;

use OCA\Files_External\Lib\Storage\SFTP;

/**
 * Class SftpTest
 *
 *
 * @package OCA\Files_External\Tests\Storage
 */
#[\PHPUnit\Framework\Attributes\Group('DB')]
class SftpTest extends \Test\Files\Storage\Storage {
	use ConfigurableStorageTrait;
	/**
	 * @var SFTP instance
	 */
	protected $instance;

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

		$id = $this->getUniqueID();
		$this->loadConfig('files_external/tests/config.sftp.php');
		$this->config['root'] .= '/' . $id; //make sure we have an new empty folder to work in
		$this->instance = new SFTP($this->config);
		$this->instance->mkdir('/');
	}

	protected function tearDown(): void {
		if ($this->instance) {
			$this->instance->rmdir('/');
		}

		parent::tearDown();
	}

	#[\PHPUnit\Framework\Attributes\DataProvider('configProvider')]
	public function testStorageId($config, $expectedStorageId): void {
		$instance = new SFTP($config);
		$this->assertEquals($expectedStorageId, $instance->getId());
	}

	public static function configProvider(): array {
		return [
			[
				// no root path
				[
					'run' => true,
					'host' => 'somehost',
					'user' => 'someuser',
					'password' => 'somepassword',
					'root' => '',
				],
				'sftp::someuser@somehost//',
			],
			[
				// without leading nor trailing slash
				[
					'run' => true,
					'host' => 'somehost',
					'user' => 'someuser',
					'password' => 'somepassword',
					'root' => 'remotedir/subdir',
				],
				'sftp::someuser@somehost//remotedir/subdir/',
			],
			[
				// regular path
				[
					'run' => true,
					'host' => 'somehost',
					'user' => 'someuser',
					'password' => 'somepassword',
					'root' => '/remotedir/subdir/',
				],
				'sftp::someuser@somehost//remotedir/subdir/',
			],
			[
				// different port
				[
					'run' => true,
					'host' => 'somehost:8822',
					'user' => 'someuser',
					'password' => 'somepassword',
					'root' => 'remotedir/subdir/',
				],
				'sftp::someuser@somehost:8822//remotedir/subdir/',
			],
			[
				// ipv6 with port
				[
					'run' => true,
					'host' => 'FE80:0000:0000:0000:0202:B3FF:FE1E:8329',
					'user' => 'someuser',
					'password' => 'somepassword',
					'root' => 'remotedir/subdir/',
				],
				'sftp::someuser@FE80:0000:0000:0000:0202:B3FF:FE1E:8329//remotedir/subdir/',
			],
			[
				// ipv6 without port
				[
					'run' => true,
					'host' => 'FE80:0000:0000:0000:0202:B3FF:FE1E:8329:8822',
					'user' => 'someuser',
					'password' => 'somepassword',
					'root' => 'remotedir/subdir/',
				],
				'sftp::someuser@FE80:0000:0000:0000:0202:B3FF:FE1E:8329:8822//remotedir/subdir/',
			],
			[
				// collapsed ipv6 with port
				[
					'run' => true,
					'host' => 'FE80::0202:B3FF:FE1E:8329:8822',
					'user' => 'someuser',
					'password' => 'somepassword',
					'root' => 'remotedir/subdir/',
				],
				'sftp::someuser@FE80::0202:B3FF:FE1E:8329:8822//remotedir/subdir/',
			],
		];
	}
}