feat: Windows Support

.circleci/doTests.sh

@@ -144,7 +144,7 @@ do
         fi
         cd ../
         echo $SUPERTOKENS_API_KEY > apiPassword
-        ./startTestingEnv --cicd
+        ./startTestEnv --cicd
 
         if [[ $? -ne 0 ]]
         then

.github/workflows/tests.yml

@@ -34,4 +34,4 @@ jobs:
       - name: Copying current supertokens-core branch into supertokens-root
         run: cd ../supertokens-root && rm -rf ./supertokens-core && cp -r ../supertokens-core ./
       - name: Building and running tests
-        run: cd ../supertokens-root && ./startTestingEnv
+        run: cd ../supertokens-root && ./startTestEnv --cicd

CHANGELOG.md

@@ -9,6 +9,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Fixes base_path config option not being observed when running `supertokens list`
 - Adds base_path normalization logic
+- Adds experimental Windows support via Git Bash and WSL2
 
 ## [3.12.1] - 2022-04-02
 

src/test/java/io/supertokens/test/AuthRecipeTest.java

@@ -205,8 +205,11 @@ public void paginationTest() throws Exception {
         }
 
         UserInfo user1 = EmailPassword.signUp(process.getProcess(), "[email protected]", "password0");
+        Thread.sleep(1); // Sleep to remove race condition
         UserInfo user2 = EmailPassword.signUp(process.getProcess(), "[email protected]", "password1");
+        Thread.sleep(1);
         UserInfo user3 = EmailPassword.signUp(process.getProcess(), "[email protected]", "password2");
+        Thread.sleep(1);
         UserInfo user4 = EmailPassword.signUp(process.getProcess(), "[email protected]", "password3");
 
         {

src/test/java/io/supertokens/test/ConfigTest2_6.java

@@ -29,6 +29,8 @@
 import org.junit.rules.TestRule;
 
 import java.io.File;
+import java.io.FileNotFoundException;
+import java.nio.file.Files;
 
 import static junit.framework.TestCase.assertEquals;
 import static junit.framework.TestCase.assertFalse;
@@ -165,16 +167,12 @@ public void testThatNonTestingConfigValuesThrowErrors() throws Exception {
     public void testThatMissingConfigFileThrowsError() throws Exception {
         String[] args = { "../" };
 
-        ProcessBuilder pb = new ProcessBuilder("rm", "config.yaml");
-        pb.directory(new File(args[0]));
-        Process process1 = pb.start();
-        process1.waitFor();
+        Files.delete(new File(args[0] + "config.yaml").toPath());
 
         TestingProcess process = TestingProcessManager.start(args);
         ProcessState.EventAndException e = process.checkOrWaitForEvent(ProcessState.PROCESS_STATE.INIT_FAILURE);
         assertNotNull(e);
-        assertEquals(e.exception.getMessage(),
-                "java.io.FileNotFoundException: ../config.yaml (No such file or directory)");
+        assertTrue(e.exception.getCause() instanceof FileNotFoundException);
 
         process.kill();
         assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STOPPED));

src/test/java/io/supertokens/test/LoggingTest.java

@@ -254,11 +254,10 @@ public void testThatSubFoldersAreCreated() throws Exception {
             assertFalse(logFile.isDirectory());
 
         } finally {
-
-            FileUtils.deleteDirectory(new File("../temp/a"));
-
             process.kill();
             assertNotNull(process.checkOrWaitForEvent(PROCESS_STATE.STOPPED));
+
+            FileUtils.deleteDirectory(new File("../temp/a"));
         }
 
     }

src/test/java/io/supertokens/test/Utils.java

@@ -18,6 +18,7 @@
 
 import com.google.gson.JsonObject;
 import io.supertokens.Main;
+import io.supertokens.exceptions.QuitProgramException;
 import io.supertokens.pluginInterface.PluginInterfaceTesting;
 import io.supertokens.storageLayer.StorageLayer;
 import io.supertokens.test.httpRequest.HttpRequestForTesting;
@@ -31,22 +32,21 @@
 
 import java.io.*;
 import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
+import java.nio.file.*;
 import java.util.Arrays;
+import java.util.regex.Pattern;
 
 public abstract class Utils extends Mockito {
 
     private static ByteArrayOutputStream byteArrayOutputStream;
+    private static final String newLine = System.lineSeparator();
 
     public static void afterTesting() {
         String installDir = "../";
         try {
 
             // remove config.yaml file
-            ProcessBuilder pb = new ProcessBuilder("rm", "config.yaml");
-            pb.directory(new File(installDir));
-            Process process = pb.start();
-            process.waitFor();
+            Files.delete(new File(installDir + "config.yaml").toPath()); // Use behavior of rm command
 
             // remove webserver-temp folders created by tomcat
             final File webserverTemp = new File(installDir + "webserver-temp");
@@ -104,23 +104,22 @@ public static void reset() {
         PluginInterfaceTesting.isTesting = true;
         Main.makeConsolePrintSilent = true;
         String installDir = "../";
+        if (!new File(installDir + ".testEnvRunning").exists())
+            throw new QuitProgramException(
+                    "Testing environment is not running! Run the startTestEnv script to start it.");
         try {
-
             // if the default config is not the same as the current config, we must reset the storage layer
-            File ogConfig = new File("../temp/config.yaml");
-            File currentConfig = new File("../config.yaml");
-            if (currentConfig.isFile()) {
-                byte[] ogConfigContent = Files.readAllBytes(ogConfig.toPath());
-                byte[] currentConfigContent = Files.readAllBytes(currentConfig.toPath());
+            Path ogConfig = new File(installDir + "temp/config.yaml").toPath();
+            Path currentConfig = new File(installDir + "config.yaml").toPath();
+            if (currentConfig.toFile().isFile()) {
+                byte[] ogConfigContent = Files.readAllBytes(ogConfig);
+                byte[] currentConfigContent = Files.readAllBytes(currentConfig);
                 if (!Arrays.equals(ogConfigContent, currentConfigContent)) {
                     StorageLayer.close();
                 }
             }
 
-            ProcessBuilder pb = new ProcessBuilder("cp", "temp/config.yaml", "./config.yaml");
-            pb.directory(new File(installDir));
-            Process process = pb.start();
-            process.waitFor();
+            Files.copy(ogConfig, currentConfig, StandardCopyOption.REPLACE_EXISTING); // Use behavior of cp command
 
             // in devConfig, it's set to false. However, in config, it's commented. So we comment it out so that it
             // mimics production. Refer to https://github.com/supertokens/supertokens-core/issues/118
@@ -138,46 +137,26 @@ public static void reset() {
         System.gc();
     }
 
-    static void commentConfigValue(String key) throws IOException {
+    private static void replaceConfigValue(String regex, String newStr) throws IOException {
         // we close the storage layer since there might be a change in the db related config.
         StorageLayer.close();
+        Path configPath = new File("../config.yaml").toPath();
+        String originalFileContent = Files.readString(configPath);
+        String modifiedFileContent = originalFileContent.replaceAll(regex, newStr);
+        String normalizedFileContent = modifiedFileContent.replaceAll("\r?\n", newLine); // Normalize line endings
+        Files.writeString(configPath, normalizedFileContent);
+    }
 
-        String oldStr = "\n((#\\s)?)" + key + "(:|((:\\s).+))\n";
-        String newStr = "\n# " + key + ":";
-
-        StringBuilder originalFileContent = new StringBuilder();
-        try (BufferedReader reader = new BufferedReader(new FileReader("../config.yaml"))) {
-            String currentReadingLine = reader.readLine();
-            while (currentReadingLine != null) {
-                originalFileContent.append(currentReadingLine).append(System.lineSeparator());
-                currentReadingLine = reader.readLine();
-            }
-            String modifiedFileContent = originalFileContent.toString().replaceAll(oldStr, newStr);
-            try (BufferedWriter writer = new BufferedWriter(new FileWriter("../config.yaml"))) {
-                writer.write(modifiedFileContent);
-            }
-        }
-
+    public static void commentConfigValue(String key) throws IOException {
+        String find = "\r?\n\\s*#?\\s*" + Pattern.quote(key) + ":.*\r?\n";
+        String replace = newLine + "# " + key + ":" + newLine;
+        replaceConfigValue(find, replace);
     }
 
     public static void setValueInConfig(String key, String value) throws IOException {
-        // we close the storage layer since there might be a change in the db related config.
-        StorageLayer.close();
-
-        String oldStr = "\n((#\\s)?)" + key + "(:|((:\\s).+))\n";
-        String newStr = "\n" + key + ": " + value + "\n";
-        StringBuilder originalFileContent = new StringBuilder();
-        try (BufferedReader reader = new BufferedReader(new FileReader("../config.yaml"))) {
-            String currentReadingLine = reader.readLine();
-            while (currentReadingLine != null) {
-                originalFileContent.append(currentReadingLine).append(System.lineSeparator());
-                currentReadingLine = reader.readLine();
-            }
-            String modifiedFileContent = originalFileContent.toString().replaceAll(oldStr, newStr);
-            try (BufferedWriter writer = new BufferedWriter(new FileWriter("../config.yaml"))) {
-                writer.write(modifiedFileContent);
-            }
-        }
+        String find = "\r?\n\\s*#?\\s*" + Pattern.quote(key) + ":.*\r?\n";
+        String replace = newLine + key + ": " + value + newLine;
+        replaceConfigValue(find, replace);
     }
 
     public static TestRule getOnFailure() {

src/test/java/io/supertokens/test/VersionTest.java

@@ -28,6 +28,7 @@
 import org.junit.rules.TestRule;
 
 import java.io.File;
+import java.io.FileNotFoundException;
 
 import static junit.framework.TestCase.assertEquals;
 import static org.junit.Assert.assertNotNull;
@@ -90,8 +91,7 @@ public void versionFileMissingTest() throws Exception {
 
             ProcessState.EventAndException e = process.checkOrWaitForEvent(ProcessState.PROCESS_STATE.INIT_FAILURE);
             assertNotNull(e);
-            assertEquals(e.exception.getMessage(),
-                    "java.io.FileNotFoundException: ../version.yaml (No such file or directory)");
+            assertTrue(e.exception.getCause() instanceof FileNotFoundException);
 
             process.kill();
             assertNotNull(process.checkOrWaitForEvent(ProcessState.PROCESS_STATE.STOPPED));

src/test/java/io/supertokens/test/WebserverTest.java

@@ -42,9 +42,7 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
-import java.net.ConnectException;
-import java.net.InetAddress;
-import java.net.SocketTimeoutException;
+import java.net.*;
 import java.util.HashMap;
 
 import static org.junit.Assert.*;
@@ -597,26 +595,12 @@ public void differentHostNameTest() throws InterruptedException, IOException, Ht
         Utils.setValueInConfig("host", "\"localhost\"");
         hello("localhost", "3567");
         hello("127.0.0.1", "3567");
-        try {
-            hello(inetAddress.getHostAddress(), "3567");
-            if (!inetAddress.getHostAddress().equals("127.0.0.1")) {
-                fail();
-            }
-        } catch (ConnectException ignored) {
-        }
 
         Utils.reset();
 
         Utils.setValueInConfig("host", "\"127.0.0.1\"");
         hello("localhost", "3567");
         hello("127.0.0.1", "3567");
-        try {
-            hello(inetAddress.getHostAddress(), "3567");
-            if (!inetAddress.getHostAddress().equals("127.0.0.1")) {
-                fail();
-            }
-        } catch (ConnectException ignored) {
-        }
 
         Utils.reset();