feat(project): grant SFTP users access to all directories

The mittwald API requires at least one directory, so there was no way to
express what mStudio offers as a checkbox. Create SFTP User now carries
that switch and sends the project root as the single directory, matching
what mStudio stores for the same option.

Closes #58

Author: twiesing

README.md

@@ -112,7 +112,7 @@ This node provides integration with the [mittwald API v2](https://developer.mitt
 
 - **Create a project on a server**: Create a new project on a server
 - **Create an SSH user**: Create an SSH user for a project (parameters: Project, Name, Password, optional Expires At)
-- **Create an SFTP user**: Create an SFTP user for a project (parameters: Project, Name, Password, Access Level, Directories, optional Expires At)
+- **Create an SFTP user**: Create an SFTP user for a project (parameters: Project, Name, Password, Access Level, Access to All Directories, Directories, optional Expires At). Turning on _Access to All Directories_ grants the user the whole project, exactly as the equivalent option in mStudio does; leave it off to name directories individually.
 - **Delete an SSH user**: Delete an SSH user from a project (parameter: SSH User ID)
 - **Delete an SFTP user**: Delete an SFTP user from a project (parameter: SFTP User ID)
 - **Get an SSH user**: Get details of a specific SSH user (parameter: SSH User ID)

nodes/Mittwald/resources/implementations/Project/operations/createSftpUser.ts

@@ -47,12 +47,25 @@ export default projectResource
 				},
 			],
 		},
+		allDirectories: {
+			displayName: 'Access to All Directories',
+			type: 'boolean',
+			required: false,
+			default: false,
+			description:
+				'Whether the user may access every directory of the project. Turn this off to name the directories individually.',
+		},
 		directories: {
 			displayName: 'Directories',
 			type: 'string',
 			required: true,
 			default: '',
 			description: 'One or more directories, separated by commas or new lines',
+			displayOptions: {
+				show: {
+					allDirectories: [false],
+				},
+			},
 		},
 		expiresAt: {
 			displayName: 'Expires At',
@@ -63,11 +76,15 @@ export default projectResource
 		},
 	})
 	.withExecuteFn(async ({ properties, apiClient }) => {
-		const { project, description, password, accessLevel, directories, expiresAt } = properties;
-		const parsedDirectories = directories
-			.split(/\n|,/)
-			.map((directory) => directory.trim())
-			.filter((directory) => directory.length > 0);
+		const { project, description, password, accessLevel, allDirectories, directories, expiresAt } =
+			properties;
+		// The project root is what mStudio stores for "access to all directories".
+		const parsedDirectories = allDirectories
+			? ['/']
+			: directories
+					.split(/\n|,/)
+					.map((directory) => directory.trim())
+					.filter((directory) => directory.length > 0);
 
 		if (parsedDirectories.length === 0) {
 			throw new Error('At least one directory is required');

test/integration/project.sftp-user.test.ts

@@ -50,6 +50,18 @@ integrationDescribe('Project / SFTP User (integration)', () => {
 					directories: '/html',
 				},
 			})
+			.step({
+				name: 'Create SFTP User With Full Access',
+				resource: 'Project',
+				operation: 'Create SFTP User',
+				parameters: {
+					project: fromStep('Create Project'),
+					description: `${userDescription}-all`,
+					password,
+					accessLevel: 'read',
+					allDirectories: true,
+				},
+			})
 			.step({
 				name: 'List SFTP Users',
 				resource: 'Project',
@@ -66,11 +78,31 @@ integrationDescribe('Project / SFTP User (integration)', () => {
 					sftpUserId: fromStep('Create SFTP User'),
 				},
 			})
+			.step({
+				name: 'Delete SFTP User With Full Access',
+				resource: 'Project',
+				operation: 'Delete SFTP User',
+				parameters: {
+					sftpUserId: fromStep('Create SFTP User With Full Access'),
+				},
+			})
 			.run();
 
 		const projectId = result.step('Create Project').requireString('id');
 		const sftpUserId = result.step('Create SFTP User').requireString('id');
+		const fullAccessUserId = result.step('Create SFTP User With Full Access').requireString('id');
 		expect(result.step('Create SFTP User').requireString('projectId')).toBe(projectId);
+
 		expect(result.step('List SFTP Users').stringValues('id')).toContain(sftpUserId);
+		expect(result.step('List SFTP Users').stringValues('id')).toContain(fullAccessUserId);
+
+		// "Access to All Directories" has to reach the API as the project root. Read back from the
+		// list instead of Get SFTP User: right after creation the API still answers a lookup by id
+		// with "access denied; verdict: abstain".
+		const fullAccessUser = result
+			.step('List SFTP Users')
+			.items()
+			.find((item) => item.json.id === fullAccessUserId);
+		expect(fullAccessUser?.json.directories).toEqual(['/']);
 	});
 });