java.nio.FileSystem support

.gitattributes

@@ -5,3 +5,6 @@
 *.sh      text eol=lf
 *.java    text
 *.scala   text
+
+# Keep these src files in binary as used for testing
+src/it/docker-image/public/**/* binary

README.adoc

@@ -86,6 +86,45 @@ C - Adjusting Timeout and Socket Timeout
 
 ```
 
+=== Using the java.nio.file.FileSystem implementation
+
+Smbj registers a new FileSystem provider with the smb:// URLs for accessing SMB shares.
+
+NB. This is not 100% implemented as-yet, although it works for basic usage. See below for unimplemented features.
+
+A - Writing a file with a temporary filename, before moving to the final location
+
+```java
+
+    // Create the filesystem
+    Map<String, Object> env = new HashMap<>();
+    // optional, leave blank for anonymous access to the share
+    env.put(SmbFileSystemProvider.DOMAIN_PROPERTY, "domain");
+    env.put(SmbFileSystemProvider.USERNAME_PROPERTY, "userName");
+    env.put(SmbFileSystemProvider.PASSWORD_PROPERTY, "password".toCharArray());
+    FileSystems.newFileSystem(URI.create("smb://<hostname>/<sharename>"), env);
+
+    ...
+
+    // Write a file with a temporary name to ensure nobody reads while writing
+    Path path = Paths.get(URI.Create("smb://<hostname>/<sharename>/aFolder/file.txt"));
+    Path workingPath = path.resolveSibling(path.getFileName().toString() + ".working");
+
+    Files.createDirectories(workingPath.getParent());
+    try (Writer w = Files.newBufferedWriter(workingPath)) {
+        w.write("Hello World");
+    }
+    Files.move(workingPath, path);
+```
+
+==== Unimplemented features
+
+* SMBException -> IOException translation
+* WatchService
+* file attributes
+* FileStores
+* UserPrincipalLookupService
+
 == Frequently Asked Questions
 
 === When I run my code I get an `SMBApiException` with the message `STATUS_... (0x...)`. What am I doing wrong?

build.gradle

@@ -1,6 +1,5 @@
 import com.bmuschko.gradle.docker.tasks.container.*
 import com.bmuschko.gradle.docker.tasks.image.*
-import java.text.SimpleDateFormat
 
 plugins {
   id "java"
@@ -50,6 +49,7 @@ dependencies {
   implementation BCPROV_JDK15ON
   implementation MBASSADOR
   implementation ASN_ONE
+  testImplementation GUAVA_TESTLIB
 }
 
 license {
@@ -96,7 +96,9 @@ testing {
         runtimeOnly OBJENESIS
         implementation SPOCK_CORE
         implementation COMMONS_IO
-        implementation "org.mockito:mockito-core:5.4.0"
+        implementation enforcedPlatform("org.mockito:mockito-bom:5.4.0")
+        implementation "org.mockito:mockito-core"
+        implementation "org.mockito:mockito-junit-jupiter"
         implementation "org.assertj:assertj-core:3.24.2"
         runtimeOnly LOGBACK_CLASSIC
       }

gradle.properties

@@ -1,6 +1,7 @@
 BCPROV_JDK15ON=org.bouncycastle:bcprov-jdk18on:1.79
 CGLIB_NODEP=cglib:cglib-nodep:3.3.0
 COMMONS_IO=commons-io:commons-io:2.16.1
+GUAVA_TESTLIB=com.google.guava:guava-testlib:33.4.0-jre
 LOGBACK_CLASSIC=ch.qos.logback:logback-classic:1.5.6
 MBASSADOR=net.engio:mbassador:1.3.0
 OBJENESIS=org.objenesis:objenesis:3.4

src/it/docker-image/Dockerfile

@@ -11,7 +11,7 @@ COPY entrypoint.sh /entrypoint.sh
 ADD public /opt/samba/share
 
 RUN mkdir -p /opt/samba/readonly /opt/samba/user /opt/samba/dfs && \
-    chmod 777 /opt/samba/readonly /opt/samba/user /opt/samba/dfs && \
+    chmod 777 /opt/samba/readonly /opt/samba/user /opt/samba/dfs /opt/samba/share && \
     adduser -s /bin/false "$SMB_USER" -D $SMB_PASSWORD && \
     (echo "$SMB_PASSWORD"; echo "$SMB_PASSWORD" ) | pdbedit -a -u "$SMB_USER" && \
     chmod ugo+x /entrypoint.sh

src/it/java/com/hierynomus/smbj/AnonymousIntegrationTest.java

@@ -15,13 +15,6 @@
  */
 package com.hierynomus.smbj;
 
-import org.junit.jupiter.api.Test;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.Arguments;
-import org.junit.jupiter.params.provider.MethodSource;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
-
 import com.hierynomus.mssmb2.SMB2Dialect;
 import com.hierynomus.security.bc.BCSecurityProvider;
 import com.hierynomus.smbj.auth.AuthenticationContext;
@@ -30,18 +23,27 @@
 import com.hierynomus.smbj.share.DiskShare;
 import com.hierynomus.smbj.share.Share;
 import com.hierynomus.smbj.testcontainers.SambaContainer;
-
-import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
 
 import java.util.stream.Stream;
 
-import static com.hierynomus.smbj.testing.TestingUtils.*;
+import static com.hierynomus.smbj.testing.TestingUtils.config;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
 
 @Testcontainers
 public class AnonymousIntegrationTest {
 
     @Container
-    private static final SambaContainer samba = new SambaContainer.Builder().build();
+    private static final SambaContainer samba = SambaContainer.INSTANCE;
 
     static Stream<Arguments> connectWith() {
         return Stream.of(

src/it/java/com/hierynomus/smbj/ChangeNotifyIntegrationTest.java

@@ -15,23 +15,6 @@
  */
 package com.hierynomus.smbj;
 
-import static com.hierynomus.mssmb2.SMB2CompletionFilter.FILE_NOTIFY_CHANGE_FILE_NAME;
-import static com.hierynomus.mssmb2.SMB2CompletionFilter.FILE_NOTIFY_CHANGE_LAST_WRITE;
-import static com.hierynomus.mssmb2.SMB2CompletionFilter.FILE_NOTIFY_CHANGE_SIZE;
-import static com.hierynomus.smbj.testing.TestingUtils.DEFAULT_AUTHENTICATION_CONTEXT;
-import static org.assertj.core.api.Assertions.*;
-import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
-
-import java.nio.charset.StandardCharsets;
-import java.util.EnumSet;
-import java.util.concurrent.Future;
-
-import org.assertj.core.api.InstanceOfAssertFactories;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.MethodSource;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
-
 import com.hierynomus.msdtyp.AccessMask;
 import com.hierynomus.msfscc.FileAttributes;
 import com.hierynomus.msfscc.FileNotifyAction;
@@ -46,11 +29,28 @@
 import com.hierynomus.smbj.share.DiskShare;
 import com.hierynomus.smbj.share.File;
 import com.hierynomus.smbj.testcontainers.SambaContainer;
+import org.assertj.core.api.InstanceOfAssertFactories;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import java.nio.charset.StandardCharsets;
+import java.util.EnumSet;
+import java.util.concurrent.Future;
+
+import static com.hierynomus.mssmb2.SMB2CompletionFilter.FILE_NOTIFY_CHANGE_FILE_NAME;
+import static com.hierynomus.mssmb2.SMB2CompletionFilter.FILE_NOTIFY_CHANGE_LAST_WRITE;
+import static com.hierynomus.mssmb2.SMB2CompletionFilter.FILE_NOTIFY_CHANGE_SIZE;
+import static com.hierynomus.smbj.testing.TestingUtils.DEFAULT_AUTHENTICATION_CONTEXT;
+import static org.assertj.core.api.Assertions.as;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 
 @Testcontainers
 public class ChangeNotifyIntegrationTest {
     @Container
-    private static final SambaContainer samba = new SambaContainer.Builder().build();
+    private static final SambaContainer samba = SambaContainer.INSTANCE;
 
     @ParameterizedTest(name = "should watch changes")
     @MethodSource("com.hierynomus.smbj.testing.TestingUtils#defaultTestingConfig")

src/it/java/com/hierynomus/smbj/DfsIntegrationTest.java

@@ -15,17 +15,6 @@
  */
 package com.hierynomus.smbj;
 
-import static com.hierynomus.smbj.testing.TestingUtils.DEFAULT_AUTHENTICATION_CONTEXT;
-import static org.assertj.core.api.Assertions.assertThat;
-
-import java.util.EnumSet;
-import java.util.List;
-
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.MethodSource;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
-
 import com.hierynomus.msdtyp.AccessMask;
 import com.hierynomus.msfscc.fileinformation.FileIdBothDirectoryInformation;
 import com.hierynomus.mssmb2.SMB2CreateDisposition;
@@ -34,11 +23,21 @@
 import com.hierynomus.smbj.share.DiskShare;
 import com.hierynomus.smbj.testcontainers.SambaContainer;
 import com.hierynomus.smbj.testing.TestingUtils.ConsumerWithError;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import java.util.EnumSet;
+import java.util.List;
+
+import static com.hierynomus.smbj.testing.TestingUtils.DEFAULT_AUTHENTICATION_CONTEXT;
+import static org.assertj.core.api.Assertions.assertThat;
 
 @Testcontainers
 public class DfsIntegrationTest {
     @Container
-    private static final SambaContainer samba = new SambaContainer.Builder().build();
+    private static final SambaContainer samba = SambaContainer.INSTANCE;
 
     @ParameterizedTest(name = "should connect to DFS share")
     @MethodSource("com.hierynomus.smbj.testing.TestingUtils#dfsConfig")

src/it/java/com/hierynomus/smbj/IntegrationTest.java

@@ -15,30 +15,29 @@
  */
 package com.hierynomus.smbj;
 
-import static com.hierynomus.smbj.testing.TestingUtils.DEFAULT_AUTHENTICATION_CONTEXT;
-import static org.assertj.core.api.Assertions.as;
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
-
-import java.util.List;
-
+import com.hierynomus.msfscc.fileinformation.FileIdBothDirectoryInformation;
+import com.hierynomus.mssmb2.SMB2Dialect;
+import com.hierynomus.smbj.share.DiskShare;
+import com.hierynomus.smbj.share.Share;
+import com.hierynomus.smbj.testcontainers.SambaContainer;
 import org.assertj.core.api.InstanceOfAssertFactories;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
-import com.hierynomus.msfscc.fileinformation.FileIdBothDirectoryInformation;
-import com.hierynomus.mssmb2.SMB2Dialect;
-import com.hierynomus.smbj.share.DiskShare;
-import com.hierynomus.smbj.share.Share;
-import com.hierynomus.smbj.testcontainers.SambaContainer;
+import java.util.List;
+
+import static com.hierynomus.smbj.testing.TestingUtils.DEFAULT_AUTHENTICATION_CONTEXT;
+import static org.assertj.core.api.Assertions.as;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 
 @Testcontainers
 public class IntegrationTest {
     @Container
-    private static final SambaContainer samba = new SambaContainer.Builder().build();
+    private static final SambaContainer samba = SambaContainer.INSTANCE;
 
     @ParameterizedTest(name = "should connect")
     @MethodSource("com.hierynomus.smbj.testing.TestingUtils#defaultTestingConfig")

src/it/java/com/hierynomus/smbj/SMB2DirectoryIntegrationTest.java

@@ -15,15 +15,6 @@
  */
 package com.hierynomus.smbj;
 
-import java.nio.charset.StandardCharsets;
-import java.util.EnumSet;
-import java.util.List;
-
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.MethodSource;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
-
 import com.hierynomus.msdtyp.AccessMask;
 import com.hierynomus.msfscc.fileinformation.FileIdBothDirectoryInformation;
 import com.hierynomus.mssmb2.SMB2CreateDisposition;
@@ -34,16 +25,24 @@
 import com.hierynomus.smbj.share.DiskShare;
 import com.hierynomus.smbj.share.File;
 import com.hierynomus.smbj.testcontainers.SambaContainer;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import java.nio.charset.StandardCharsets;
+import java.util.EnumSet;
+import java.util.List;
 
-import static com.hierynomus.smbj.testing.TestingUtils.*;
+import static com.hierynomus.smbj.testing.TestingUtils.DEFAULT_AUTHENTICATION_CONTEXT;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 
 @Testcontainers
 public class SMB2DirectoryIntegrationTest {
 
     @Container
-    private static final SambaContainer samba = new SambaContainer.Builder().build();
+    private static final SambaContainer samba = SambaContainer.INSTANCE;
 
     @ParameterizedTest(name = "should open directory")
     @MethodSource("com.hierynomus.smbj.testing.TestingUtils#defaultTestingConfig")