From 1281a730e836fbb9e4b306aae1ab829c61a78f1a Mon Sep 17 00:00:00 2001
From: Sagar Gurung <46086950+SagarGi@users.noreply.github.com>
Date: Thu, 1 Feb 2024 13:54:44 +0545
Subject: [PATCH]  [tests-only] Added test for sharingNg for endpoint
 sharedByMe from personal space (#8285)

* Added tests to list shared by me resources

Signed-off-by: sagargurung1001@gmail.com <sagargurung1001@gmail.com>

* Review address

---------

Signed-off-by: sagargurung1001@gmail.com <sagargurung1001@gmail.com>
---
 tests/TestHelpers/GraphHelper.php             |  25 +
 .../features/apiSharingNg/sharedByMe.feature  | 614 ++++++++++++++++++
 .../features/bootstrap/GraphContext.php       |  58 ++
 3 files changed, 697 insertions(+)
 create mode 100644 tests/acceptance/features/apiSharingNg/sharedByMe.feature

diff --git a/tests/TestHelpers/GraphHelper.php b/tests/TestHelpers/GraphHelper.php
index d81e31625..8ff0c9c25 100644
--- a/tests/TestHelpers/GraphHelper.php
+++ b/tests/TestHelpers/GraphHelper.php
@@ -1868,4 +1868,29 @@ class GraphHelper {
 			self::getRequestHeaders()
 		);
 	}
+
+	/**
+	 * @param string $baseUrl
+	 * @param string $xRequestId
+	 * @param string $user
+	 * @param string $password
+	 *
+	 * @return ResponseInterface
+	 * @throws GuzzleException
+	 */
+	public static function getSharesSharedByMe(
+		string $baseUrl,
+		string $xRequestId,
+		string $user,
+		string $password
+	): ResponseInterface {
+		$url = self::getBetaFullUrl($baseUrl, "me/drive/sharedByMe");
+		return HttpRequestHelper::get(
+			$url,
+			$xRequestId,
+			$user,
+			$password,
+			self::getRequestHeaders()
+		);
+	}
 }
diff --git a/tests/acceptance/features/apiSharingNg/sharedByMe.feature b/tests/acceptance/features/apiSharingNg/sharedByMe.feature
new file mode 100644
index 000000000..061ec773a
--- /dev/null
+++ b/tests/acceptance/features/apiSharingNg/sharedByMe.feature
@@ -0,0 +1,614 @@
+Feature: resources shared by user
+  As a user
+  I want to get resources shared by me
+  So that I can know about what resources are shared with others
+
+  https://owncloud.dev/libre-graph-api/#/me.drive/ListSharedByMe
+
+  Background:
+    Given these users have been created with default attributes and without skeleton files:
+      | username |
+      | Alice    |
+      | Brian    |
+
+
+  Scenario: user lists the shared file from personal space
+    Given user "Alice" has uploaded file with content "hello world" to "textfile.txt"
+    And user "Alice" has sent the following share invitation:
+      | resourceType    | file         |
+      | resource        | textfile.txt |
+      | space           | Personal     |
+      | sharee          | Brian        |
+      | shareType       | user         |
+      | permissionsRole | Viewer       |
+    When user "Alice" lists the resources shared by her using the Graph API
+    Then the HTTP status code should be "200"
+    And the JSON data of the response should contain file name "textfile.txt" with the following data:
+    """
+    {
+      "type": "object",
+      "required": [
+        "parentReference",
+        "permissions",
+        "name",
+        "size"
+      ],
+      "properties": {
+        "parentReference": {
+          "type": "object",
+          "required": [
+            "driveId",
+            "driveType",
+            "path",
+            "name",
+            "id"
+          ],
+          "properties": {
+            "driveId": {
+              "type": "string",
+              "pattern": "^%space_id_pattern%$"
+            },
+            "driveType": {
+              "type": "string",
+              "enum": ["personal"]
+            },
+            "path": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "name": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "id": {
+              "type": "string",
+              "pattern": "^%file_id_pattern%$"
+            }
+          }
+        },
+        "permissions": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "required": [
+                "grantedToV2",
+                "id",
+                "roles"
+              ],
+              "properties": {
+                "grantedToV2": {
+                  "type": "object",
+                  "required": [
+                    "user"
+                  ],
+                  "properties": {
+                    "user": {
+                      "type": "object",
+                      "required": [
+                        "displayName",
+                        "id"
+                      ],
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "pattern": "^%user_id_pattern%$"
+                        },
+                        "displayName": {
+                          "type": "string",
+                          "enum": [
+                            "Brian Murphy"
+                          ]
+                        }
+                      }
+                    }
+                  }
+                },
+                "id": {
+                  "type": "string",
+                  "pattern": "^%permissions_id_pattern%$"
+                },
+                "roles": {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "pattern": "^%role_id_pattern%$"
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        },
+        "name": {
+          "type": "string",
+          "enum": ["textfile.txt"]
+        },
+        "size": {
+          "type": "number",
+          "enum": [
+            11
+          ]
+        }
+      }
+    }
+    """
+
+
+  Scenario: user lists the shared file inside of a folder from personal space
+    Given user "Alice" has created folder "FolderToShare"
+    And user "Alice" has uploaded file with content "hello world" to "FolderToShare/textfile.txt"
+    And user "Alice" has sent the following share invitation:
+      | resourceType    | file                       |
+      | resource        | FolderToShare/textfile.txt |
+      | space           | Personal                   |
+      | sharee          | Brian                      |
+      | shareType       | user                       |
+      | permissionsRole | Viewer                     |
+    When user "Alice" lists the resources shared by her using the Graph API
+    Then the HTTP status code should be "200"
+    And the JSON data of the response should contain file name "textfile.txt" with the following data:
+    """
+    {
+      "type": "object",
+      "required": [
+        "parentReference",
+        "permissions",
+        "name",
+        "size"
+      ],
+      "properties": {
+        "parentReference": {
+          "type": "object",
+          "required": [
+            "driveId",
+            "driveType",
+            "path",
+            "name",
+            "id"
+          ],
+          "properties": {
+            "driveId": {
+              "type": "string",
+              "pattern": "^%space_id_pattern%$"
+            },
+            "driveType": {
+              "type": "string",
+              "enum": ["personal"]
+            },
+            "path": {
+              "type": "string",
+              "enum": ["/FolderToShare"]
+            },
+            "name": {
+              "type": "string",
+              "enum": ["FolderToShare"]
+            },
+            "id": {
+              "type": "string",
+              "pattern": "^%file_id_pattern%$"
+            }
+          }
+        },
+        "permissions": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "required": [
+                "grantedToV2",
+                "id",
+                "roles"
+              ],
+              "properties": {
+                "grantedToV2": {
+                  "type": "object",
+                  "required": [
+                    "user"
+                  ],
+                  "properties": {
+                    "user": {
+                      "type": "object",
+                      "required": [
+                        "displayName",
+                        "id"
+                      ],
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "pattern": "^%user_id_pattern%$"
+                        },
+                        "displayName": {
+                          "type": "string",
+                          "enum": [
+                            "Brian Murphy"
+                          ]
+                        }
+                      }
+                    }
+                  }
+                },
+                "id": {
+                  "type": "string",
+                  "pattern": "^%permissions_id_pattern%$"
+                },
+                "roles": {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "pattern": "^%role_id_pattern%$"
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        },
+        "name": {
+          "type": "string",
+          "enum": ["textfile.txt"]
+        },
+        "size": {
+          "type": "number",
+          "enum": [
+            11
+          ]
+        }
+      }
+    }
+    """
+
+
+  Scenario: user lists the shared folder from personal space
+    Given user "Alice" has created folder "FolderToShare"
+    And user "Alice" has sent the following share invitation:
+      | resourceType    | folder        |
+      | resource        | FolderToShare |
+      | space           | Personal      |
+      | sharee          | Brian         |
+      | shareType       | user          |
+      | permissionsRole | Viewer        |
+    When user "Alice" lists the resources shared by her using the Graph API
+    Then the HTTP status code should be "200"
+    And the JSON data of the response should contain file name "FolderToShare" with the following data:
+    """
+    {
+      "type": "object",
+      "required": [
+        "parentReference",
+        "permissions",
+        "name"
+      ],
+      "properties": {
+        "parentReference": {
+          "type": "object",
+          "required": [
+            "driveId",
+            "driveType",
+            "path",
+            "name",
+            "id"
+          ],
+          "properties": {
+            "driveId": {
+              "type": "string",
+              "pattern": "^%space_id_pattern%$"
+            },
+            "driveType": {
+              "type": "string",
+              "enum": ["personal"]
+            },
+            "path": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "name": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "id": {
+              "type": "string",
+              "pattern": "^%file_id_pattern%$"
+            }
+          }
+        },
+        "permissions": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "required": [
+                "grantedToV2",
+                "id",
+                "roles"
+              ],
+              "properties": {
+                "grantedToV2": {
+                  "type": "object",
+                  "required": [
+                    "user"
+                  ],
+                  "properties": {
+                    "user": {
+                      "type": "object",
+                      "required": [
+                        "displayName",
+                        "id"
+                      ],
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "pattern": "^%user_id_pattern%$"
+                        },
+                        "displayName": {
+                          "type": "string",
+                          "enum": [
+                            "Brian Murphy"
+                          ]
+                        }
+                      }
+                    }
+                  }
+                },
+                "id": {
+                  "type": "string",
+                  "pattern": "^%permissions_id_pattern%$"
+                },
+                "roles": {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "pattern": "^%role_id_pattern%$"
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        },
+        "name": {
+          "type": "string",
+          "enum": ["FolderToShare"]
+        }
+      }
+    }
+    """
+
+
+  Scenario: user lists shared resources from personal space
+    Given user "Alice" has created folder "FolderToShare"
+    And user "Alice" has uploaded file with content "hello world" to "textfile.txt"
+    And user "Alice" has sent the following share invitation:
+      | resourceType    | file         |
+      | resource        | textfile.txt |
+      | space           | Personal     |
+      | sharee          | Brian        |
+      | shareType       | user         |
+      | permissionsRole | Viewer       |
+    And user "Alice" has sent the following share invitation:
+      | resourceType    | folder        |
+      | resource        | FolderToShare |
+      | space           | Personal      |
+      | sharee          | Brian         |
+      | shareType       | user          |
+      | permissionsRole | Viewer        |
+    When user "Alice" lists the resources shared by her using the Graph API
+    Then the HTTP status code should be "200"
+    And the JSON data of the response should contain file name "textfile.txt" with the following data:
+    """
+    {
+      "type": "object",
+      "required": [
+        "parentReference",
+        "permissions",
+        "name",
+        "size"
+      ],
+      "properties": {
+        "parentReference": {
+          "type": "object",
+          "required": [
+            "driveId",
+            "driveType",
+            "path",
+            "name",
+            "id"
+          ],
+          "properties": {
+            "driveId": {
+              "type": "string",
+              "pattern": "^%space_id_pattern%$"
+            },
+            "driveType": {
+              "type": "string",
+              "enum": ["personal"]
+            },
+            "path": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "name": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "id": {
+              "type": "string",
+              "pattern": "^%file_id_pattern%$"
+            }
+          }
+        },
+        "permissions": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "required": [
+                "grantedToV2",
+                "id",
+                "roles"
+              ],
+              "properties": {
+                "grantedToV2": {
+                  "type": "object",
+                  "required": [
+                    "user"
+                  ],
+                  "properties": {
+                    "user": {
+                      "type": "object",
+                      "required": [
+                        "displayName",
+                        "id"
+                      ],
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "pattern": "^%user_id_pattern%$"
+                        },
+                        "displayName": {
+                          "type": "string",
+                          "enum": [
+                            "Brian Murphy"
+                          ]
+                        }
+                      }
+                    }
+                  }
+                },
+                "id": {
+                  "type": "string",
+                  "pattern": "^%permissions_id_pattern%$"
+                },
+                "roles": {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "pattern": "^%role_id_pattern%$"
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        },
+        "name": {
+          "type": "string",
+          "enum": ["textfile.txt"]
+        },
+        "size": {
+          "type": "number",
+          "enum": [
+            11
+          ]
+        }
+      }
+    }
+    """
+    And the JSON data of the response should contain file name "FolderToShare" with the following data:
+    """
+    {
+      "type": "object",
+      "required": [
+        "parentReference",
+        "permissions",
+        "name"
+      ],
+      "properties": {
+        "parentReference": {
+          "type": "object",
+          "required": [
+            "driveId",
+            "driveType",
+            "path",
+            "name",
+            "id"
+          ],
+          "properties": {
+            "driveId": {
+              "type": "string",
+              "pattern": "^%space_id_pattern%$"
+            },
+            "driveType": {
+              "type": "string",
+              "enum": ["personal"]
+            },
+            "path": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "name": {
+              "type": "string",
+              "enum": ["/"]
+            },
+            "id": {
+              "type": "string",
+              "pattern": "^%file_id_pattern%$"
+            }
+          }
+        },
+        "permissions": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "required": [
+                "grantedToV2",
+                "id",
+                "roles"
+              ],
+              "properties": {
+                "grantedToV2": {
+                  "type": "object",
+                  "required": [
+                    "user"
+                  ],
+                  "properties": {
+                    "user": {
+                      "type": "object",
+                      "required": [
+                        "displayName",
+                        "id"
+                      ],
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "pattern": "^%user_id_pattern%$"
+                        },
+                        "displayName": {
+                          "type": "string",
+                          "enum": [
+                            "Brian Murphy"
+                          ]
+                        }
+                      }
+                    }
+                  }
+                },
+                "id": {
+                  "type": "string",
+                  "pattern": "^%permissions_id_pattern%$"
+                },
+                "roles": {
+                  "type": "array",
+                  "items": [
+                    {
+                      "type": "string",
+                      "pattern": "^%role_id_pattern%$"
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        },
+        "name": {
+          "type": "string",
+          "enum": ["FolderToShare"]
+        }
+      }
+    }
+    """
diff --git a/tests/acceptance/features/bootstrap/GraphContext.php b/tests/acceptance/features/bootstrap/GraphContext.php
index ec322b499..4838a4513 100644
--- a/tests/acceptance/features/bootstrap/GraphContext.php
+++ b/tests/acceptance/features/bootstrap/GraphContext.php
@@ -2525,4 +2525,62 @@ class GraphContext implements Context {
 			)
 		);
 	}
+
+	/**
+	 * @When user :user lists the resources shared by him/her using the Graph API
+	 *
+	 * @param string $user
+	 *
+	 * @return void
+	 * @throws GuzzleException
+	 */
+	public function userListsTheResourcesSharedByAUserUsingGraphApi(string $user): void {
+		$credentials = $this->getAdminOrUserCredentials($user);
+		$this->featureContext->setResponse(
+			GraphHelper::getSharesSharedByMe(
+				$this->featureContext->getBaseUrl(),
+				$this->featureContext->getStepLineRef(),
+				$credentials['username'],
+				$credentials['password']
+			)
+		);
+	}
+
+	/**
+	 * @Then /^the JSON data of the response should (not )?contain file name "([^"]*)" with the following data:?$/
+	 *
+	 * @param string $shouldOrNot (not| )
+	 * @param string $fileName
+	 * @param PyStringNode $schemaString
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function theJsonDataResponseShouldOrNotContainSharedByMeDetails(
+		string $shouldOrNot,
+		string $fileName,
+		PyStringNode $schemaString
+	): void {
+		$responseBody = $this->featureContext->getJsonDecodedResponseBodyContent()->value;
+		$fileOrFolderFound = false;
+		foreach ($responseBody as $value) {
+			if (isset($value->name) && $value->name === $fileName) {
+				$responseBody = $value;
+				$fileOrFolderFound = true;
+				break;
+			}
+		}
+		$shouldContain = \trim($shouldOrNot) !== 'not';
+		if (!$shouldContain && !$fileOrFolderFound) {
+			return;
+		}
+		Assert::assertFalse(
+			!$shouldContain && $fileOrFolderFound,
+			'Response contains file "' . $fileName . '" but should.'
+		);
+		$this->featureContext->assertJsonDocumentMatchesSchema(
+			$responseBody,
+			$this->featureContext->getJSONSchema($schemaString)
+		);
+	}
 }