chore: add file conversion integration tests

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>

.github/workflows/integration-sqlite.yml

@@ -61,6 +61,7 @@ jobs:
           - 'federation_features'
           - '--tags ~@large files_features'
           - 'filesdrop_features'
+          - 'file_conversions'
           - 'openldap_features'
           - 'openldap_numerical_features'
           - 'ldap_features'

build/integration/config/behat.yml

@@ -16,7 +16,7 @@ default:
         - "%paths.base%/../features"
       contexts:
         - FeatureContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -39,7 +39,7 @@ default:
         - "%paths.base%/../comments_features"
       contexts:
         - FeatureContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -62,7 +62,7 @@ default:
         - "%paths.base%/../dav_features"
       contexts:
         - DavFeatureContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -85,7 +85,7 @@ default:
         - "%paths.base%/../federation_features"
       contexts:
         - FederationContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -95,7 +95,7 @@ default:
         - "%paths.base%/../files_features"
       contexts:
         - FeatureContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -113,12 +113,22 @@ default:
         - CommandLineContext:
             baseUrl: http://localhost:8080
             ocPath: ../../
+    files_conversion:
+      paths:
+        - "%paths.base%/../file_conversions"
+      contexts:
+        - ConversionsContext:
+            baseUrl: http://localhost:8080
+            admin:
+              - admin
+              - admin
+            regular_user_password: 123456
     capabilities:
       paths:
         - "%paths.base%/../capabilities_features"
       contexts:
         - CapabilitiesContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -128,7 +138,7 @@ default:
         - "%paths.base%/../collaboration_features"
       contexts:
         - CollaborationContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -138,7 +148,7 @@ default:
         - "%paths.base%/../sharees_features"
       contexts:
         - ShareesContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -148,7 +158,7 @@ default:
         - "%paths.base%/../sharing_features"
       contexts:
         - SharingContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -159,7 +169,7 @@ default:
         - "%paths.base%/../videoverification_features"
       contexts:
         - SharingContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -170,7 +180,7 @@ default:
         - "%paths.base%/../setup_features"
       contexts:
         - SetupContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
@@ -220,10 +230,10 @@ default:
         - "%paths.base%/../remoteapi_features"
       contexts:
         - FeatureContext:
-            baseUrl:  http://localhost:8080/ocs/
+            baseUrl: http://localhost:8080/ocs/
             admin:
               - admin
               - admin
             regular_user_password: 123456
         - RemoteContext:
-            remote:  http://localhost:8080
+            remote: http://localhost:8080

build/integration/data/clouds.jpg.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2019 CHUTTERSNAP <https://unsplash.com/@chuttersnap> <https://unsplash.com/photos/blue-clouds-under-white-sky-9AqIdzEc9pY>"
+SPDX-License-Identifier: LicenseRef-Unsplash

build/integration/features/bootstrap/BasicStructure.php

@@ -8,6 +8,7 @@ use Behat\Gherkin\Node\TableNode;
 use GuzzleHttp\Client;
 use GuzzleHttp\Cookie\CookieJar;
 use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\ServerException;
 use PHPUnit\Framework\Assert;
 use Psr\Http\Message\ResponseInterface;
 
@@ -170,6 +171,8 @@ trait BasicStructure {
 			$this->response = $client->request($verb, $fullUrl, $options);
 		} catch (ClientException $ex) {
 			$this->response = $ex->getResponse();
+		} catch (ServerException $ex) {
+			$this->response = $ex->getResponse();
 		}
 	}
 

build/integration/features/bootstrap/ConversionsContext.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+require __DIR__ . '/../../vendor/autoload.php';
+
+use Behat\Behat\Context\Context;
+use Behat\Behat\Context\SnippetAcceptingContext;
+use Behat\Gherkin\Node\TableNode;
+
+class ConversionsContext implements Context, SnippetAcceptingContext {
+	use AppConfiguration;
+	use BasicStructure;
+	use WebDav;
+
+	/** @BeforeScenario */
+	public function setUpScenario() {
+		$this->asAn('admin');
+		$this->setStatusTestingApp(true);
+	}
+
+	/** @AfterScenario */
+	public function tearDownScenario() {
+		$this->asAn('admin');
+		$this->setStatusTestingApp(false);
+	}
+
+	protected function resetAppConfigs() {
+	}
+
+	/**
+	 * @When /^user "([^"]*)" converts file "([^"]*)" to "([^"]*)"$/
+	 */
+	public function userConvertsTheSavedFileId(string $user, string $path, string $mime) {
+		$this->userConvertsTheSavedFileIdTo($user, $path, $mime, null);
+	}
+
+	/**
+	 * @When /^user "([^"]*)" converts file "([^"]*)" to "([^"]*)" and saves it to "([^"]*)"$/
+	 */
+	public function userConvertsTheSavedFileIdTo(string $user, string $path, string $mime, ?string $destination) {
+		try {
+			$fileId = $this->getFileIdForPath($user, $path);
+		} catch (Exception $e) {
+			// return a fake value to keep going and be able to test the error
+			$fileId = 0;
+		}
+
+		$data = [['fileId', $fileId], ['targetMimeType', $mime]];
+		if ($destination !== null) {
+			$data[] = ['destination', $destination];
+		}
+
+		$this->asAn($user);
+		$this->sendingToWith('post', '/apps/files/api/v1/convert', new TableNode($data));
+	}
+}

build/integration/file_conversions/file_conversions.feature

@@ -0,0 +1,101 @@
+# SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+# SPDX-License-Identifier: AGPL-3.0-only
+
+Feature: conversions
+	Background:
+		Given using api version "2"
+    Given using new dav path
+    Given user "user0" exists
+
+  Scenario: Converting a file works
+    Given user "user0" uploads file "data/clouds.jpg" to "/image.jpg"
+    Then as "user0" the file "/image.jpg" exists
+    When user "user0" converts file "/image.jpg" to "image/png"
+    Then the HTTP status code should be "201"
+    Then the OCS status code should be "201"
+    Then as "user0" the file "/image.png" exists
+
+  Scenario: Converting a file to a given path works
+    Given user "user0" uploads file "data/clouds.jpg" to "/image.jpg"
+    And User "user0" created a folder "/folder"
+    Then as "user0" the file "/image.jpg" exists
+    Then as "user0" the folder "/folder" exists
+    When user "user0" converts file "/image.jpg" to "image/png" and saves it to "/folder/image.png"
+    Then the HTTP status code should be "201"
+    Then the OCS status code should be "201"
+    Then as "user0" the file "/folder/image.png" exists
+    Then as "user0" the file "/image.png" does not exist
+
+  Scenario: Converting a file path with overwrite
+    Given user "user0" uploads file "data/clouds.jpg" to "/image.jpg"
+    And user "user0" uploads file "data/green-square-256.png" to "/image.png"
+    Then as "user0" the file "/image.jpg" exists
+    Then as "user0" the file "/image.png" exists
+    When user "user0" converts file "/image.jpg" to "image/png"
+    Then the HTTP status code should be "201"
+    Then the OCS status code should be "201"
+    Then as "user0" the file "/image.jpg" exists
+    Then as "user0" the file "/image.png" exists
+    Then as "user0" the file "/image (2).png" exists
+
+  Scenario: Converting a file path with overwrite to a given path
+    Given user "user0" uploads file "data/clouds.jpg" to "/image.jpg"
+    And User "user0" created a folder "/folder"
+    And user "user0" uploads file "data/green-square-256.png" to "/folder/image.png"
+    Then as "user0" the file "/image.jpg" exists
+    Then as "user0" the folder "/folder" exists
+    Then as "user0" the file "/folder/image.png" exists
+    When user "user0" converts file "/image.jpg" to "image/png" and saves it to "/folder/image.png"
+    Then the HTTP status code should be "201"
+    Then the OCS status code should be "201"
+    Then as "user0" the file "/folder/image.png" exists
+    Then as "user0" the file "/folder/image (2).png" exists
+    Then as "user0" the file "/image.png" does not exist
+    Then as "user0" the file "/image.jpg" exists
+
+  Scenario: Converting a file which does not exist fails
+    When user "user0" converts file "/image.jpg" to "image/png"
+    Then the HTTP status code should be "404"
+    Then the OCS status code should be "404"
+    Then as "user0" the file "/image.jpg" does not exist
+    Then as "user0" the file "/image.png" does not exist
+
+  Scenario: Converting a file to an invalid destination path fails
+    Given user "user0" uploads file "data/clouds.jpg" to "/image.jpg"
+    When user "user0" converts file "/image.jpg" to "image/png" and saves it to "/folder/image.png"
+    Then the HTTP status code should be "404"
+    Then the OCS status code should be "404"
+    Then as "user0" the file "/image.jpg" exists
+    Then as "user0" the file "/folder/image.png" does not exist
+
+  Scenario: Converting a file to an invalid format fails
+    Given user "user0" uploads file "data/clouds.jpg" to "/image.jpg"
+    When user "user0" converts file "/image.jpg" to "image/invalid"
+    Then the HTTP status code should be "500"
+    Then the OCS status code should be "999"
+    Then as "user0" the file "/image.jpg" exists
+    Then as "user0" the file "/image.png" does not exist
+
+  Scenario: Forbid conversion to a destination without create permission
+    Given user "user1" exists
+    # Share the folder with user1
+    Given User "user0" created a folder "/folder"
+    Then As an "user0"
+    When creating a share with
+      | path | folder |
+      | shareWith | user1 |
+      | shareType | 0 |
+      | permissions | 1 |
+    Then the OCS status code should be "200"
+    And the HTTP status code should be "200"
+    # Create the folder, upload the image
+    Then As an "user1"
+    Given user "user1" accepts last share
+    Given as "user1" the folder "/folder" exists
+    Given user "user1" uploads file "data/clouds.jpg" to "/image.jpg"
+    Then as "user1" the file "/image.jpg" exists
+    # Try to convert the image to a folder where user1 has no create permission
+    When user "user1" converts file "/image.jpg" to "image/png" and saves it to "/folder/folder.png"
+    Then the OCS status code should be "403" 
+    And the HTTP status code should be "403"
+    Then as "user1" the file "/folder/folder.png" does not exist