This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/master by this push: new 44759941 Handle the case where a user does not have any groups (#280) 44759941 is described below commit 4475994185d2c3c870403b4028f4eea9fd3c2ca6 Author: Mark van der Walle <m...@vanderwalle.net> AuthorDate: Thu Jul 28 21:05:17 2022 +0200 Handle the case where a user does not have any groups (#280) * Handle the case where a user does not have any groups id -g would return the gid 0 id -G however would return only a newline * [VFS-822] Adds tests to handle regression * [VFS-822] Adds license to newly created class * [VFS-822] Remove since for non-public * [VFS-822] using private and final modifiers where applicable Co-authored-by: Mark van der Walle <mark.vander.wa...@sogeti.com> --- .../commons/vfs2/provider/sftp/SftpFileSystem.java | 28 +++++++--- .../provider/sftp/SftpFileSystemGroupsTests.java | 61 ++++++++++++++++++++++ 2 files changed, 81 insertions(+), 8 deletions(-) diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java index b1397f3c..1d9df789 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystem.java @@ -20,6 +20,7 @@ import java.io.IOException; import java.io.InputStreamReader; import java.nio.charset.StandardCharsets; import java.time.Duration; +import java.util.Arrays; import java.util.Collection; import java.util.Objects; @@ -260,21 +261,32 @@ public class SftpFileSystem extends AbstractFileSystem { throw new JSchException( "Could not get the groups id of the current user (error code: " + code + ")"); } - // Retrieve the different groups - final String[] groups = output.toString().trim().split("\\s+"); - - final int[] groupsIds = new int[groups.length]; - for (int i = 0; i < groups.length; i++) { - groupsIds[i] = Integer.parseInt(groups[i]); - } - this.groupsIds = groupsIds; + this.groupsIds = parseGroupIdOutput(output); } } } return groupsIds; } + /** + * Parses the output of the 'id -G' command + * + * @param output The output from the command + * @return the (numeric) group IDs. + */ + int[] parseGroupIdOutput(StringBuilder output) { + // Retrieve the different groups + final String[] groups = output.toString().trim().split("\\s+"); + + // Deal with potential empty groups + return Arrays.stream(groups) + .map(String::trim) + .filter(s -> !s.isEmpty()) + .mapToInt(Integer::parseInt) + .toArray(); + } + /** * Last modification time is only an int and in seconds, thus can be off by 999. * diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemGroupsTests.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemGroupsTests.java new file mode 100644 index 00000000..6a2f7103 --- /dev/null +++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/sftp/SftpFileSystemGroupsTests.java @@ -0,0 +1,61 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.vfs2.provider.sftp; + +import com.jcraft.jsch.JSch; +import com.jcraft.jsch.JSchException; +import com.jcraft.jsch.Session; +import org.apache.commons.vfs2.FileSystemOptions; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; + +public class SftpFileSystemGroupsTests { + + private final FileSystemOptions options = new FileSystemOptions(); + private Session session; + private SftpFileSystem fileSystem; + + @Before + public void setup() throws JSchException { + session = new JSch().getSession(""); + fileSystem = new SftpFileSystem(null, session, options); + } + + @Test + public void shouldHandleEmptyGroupResult() { + StringBuilder builder = new StringBuilder("\n"); + int[] groups = fileSystem.parseGroupIdOutput(builder); + + Assert.assertEquals("Group ids should be empty", 0, groups.length); + } + + @Test + public void shouldHandleListOfGroupIds() { + StringBuilder builder = new StringBuilder("1 22 333 4444\n"); + int[] groups = fileSystem.parseGroupIdOutput(builder); + + Assert.assertEquals("Group ids should not be empty", 4, groups.length); + Assert.assertArrayEquals(new int[]{1, 22, 333, 4444}, groups); + } + + @Test(expected = NumberFormatException.class) + public void shouldThrowOnUnexpectedOutput() { + StringBuilder builder = new StringBuilder("abc\n"); + fileSystem.parseGroupIdOutput(builder); + } +}