chore(cts): replace localhost at runtime

docker-compose.yml

@@ -13,7 +13,8 @@ services:
         - PHP_VERSION=${PHP_VERSION}
         - PYTHON_VERSION=${PYTHON_VERSION}
     command: tail -f /dev/null
-    volumes: [./:/app]
+    volumes: [ ./:/app ]
+
   ruby:
     container_name: apic_ruby
     build:
@@ -24,7 +25,8 @@ services:
         - NODE_VERSION=${NODE_VERSION}
         - RUBY_VERSION=${RUBY_VERSION}
     command: tail -f /dev/null
-    volumes: [./:/app]
+    volumes: [ ./:/app ]
+
   swift:
     container_name: apic_swift
     build:
@@ -35,4 +37,4 @@ services:
         - NODE_VERSION=${NODE_VERSION}
         - SWIFT_VERSION=${SWIFT_VERSION}
     command: tail -f /dev/null
-    volumes: [./:/app]
+    volumes: [ ./:/app ]

generators/src/main/java/com/algolia/codegen/cts/tests/TestsGenerator.java

@@ -95,20 +95,11 @@ protected <T> Map<String, T[]> loadFullCTS(Class<T[]> jsonType) throws Exception
 
   private String injectVariables(String json) {
     long threeDays = 3 * 24 * 60 * 60 * 1000;
-    json = json
+    return json
       .replace("${{language}}", language)
       .replace("${{languageCased}}", ctsManager.getLanguageCased())
       .replace("${{languageVersion}}", ctsManager.getVersion())
       .replace("${{clientPascalCase}}", Helpers.capitalize(Helpers.camelize(client)))
       .replace("\"${{nowRounded}}\"", String.valueOf(Math.round(System.currentTimeMillis() / threeDays) * threeDays));
-
-    if (!language.equals("javascript") && !"true".equals(System.getenv("CI"))) {
-      // hack for docker on mac, the `network=host` does not work so we need to use
-      // another local IP
-      json = json.replace("${{localhost}}", "host.docker.internal");
-    } else {
-      json = json.replace("${{localhost}}", "localhost");
-    }
-    return json;
   }
 }

scripts/cts/testServer/timeout.ts

@@ -42,7 +42,7 @@ export function assertValidTimeouts(expectedCount: number): void {
           break;
         default:
           // the delay should be the same, because the `retryCount` is per host instead of global
-          expect(state.duration[3 * i]).to.be.closeTo(state.duration[3 * i + 1], 100);
+          expect(state.duration[3 * i]).to.be.closeTo(state.duration[3 * i + 1], 150);
           break;
       }
     }

templates/csharp/tests/client/createClient.mustache

@@ -4,7 +4,7 @@
     {
       {{#customHosts}}new () {
         Scheme = HttpScheme.Http,
-        Url = "{{host}}",
+        Url = Environment.GetEnvironmentVariable("CI") == "true" ? "localhost" : "host.docker.internal",
         Port = {{port}},
         Up = true,
         LastUse = DateTime.UtcNow,

templates/csharp/tests/e2e/e2e.mustache

@@ -19,7 +19,7 @@ namespace Algolia.Search.e2e;
 
 public class {{client}}RequestTestsE2E
 {
-private readonly {{client}} client;
+  private readonly {{client}} client;
 
   public {{client}}RequestTestsE2E()
   {

templates/dart/tests/client/client.mustache

@@ -3,6 +3,7 @@ import '{{{import}}}';
 import 'package:algolia_test/algolia_test.dart';
 import 'package:test/test.dart';
 import 'package:test_api/hooks.dart';
+import 'dart:io' show Platform;
 
 void main() {
   {{#blocksClient}}

templates/dart/tests/client/createClient.mustache

@@ -1 +1 @@
-{{^autoCreateClient}}final client = {{/autoCreateClient}}{{client}}(appId : "{{parametersWithDataTypeMap.appId.value}}", apiKey : "{{parametersWithDataTypeMap.apiKey.value}}",{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}}region: '{{parametersWithDataTypeMap.region.value}}',{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}options: ClientOptions({{#useEchoRequester}}requester: requester{{/useEchoRequester}}{{#hasCustomHosts}}hosts:[{{#customHosts}}Host.create(url: '{{host}}:{{port}}', scheme: 'http'),{{/customHosts}}]{{/hasCustomHosts}}));
+{{^autoCreateClient}}final client = {{/autoCreateClient}}{{client}}(appId : "{{parametersWithDataTypeMap.appId.value}}", apiKey : "{{parametersWithDataTypeMap.apiKey.value}}",{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}}region: '{{parametersWithDataTypeMap.region.value}}',{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}options: ClientOptions({{#useEchoRequester}}requester: requester{{/useEchoRequester}}{{#hasCustomHosts}}hosts:[{{#customHosts}}Host.create(url: (Platform.environment['CI'] == 'true' ? 'localhost' : 'host.docker.internal') + ':{{port}}', scheme: 'http'),{{/customHosts}}]{{/hasCustomHosts}}));

templates/go/tests/client/createClient.mustache

@@ -6,7 +6,7 @@ cfg = {{clientPrefix}}.{{clientName}}Configuration{
     Requester: echo,
     {{/useEchoRequester}}
     {{#hasCustomHosts}}
-    Hosts: []transport.StatefulHost{ {{#customHosts}}transport.NewStatefulHost("http", "{{host}}:{{port}}", call.IsReadWrite),{{/customHosts}} },
+    Hosts: []transport.StatefulHost{ {{#customHosts}}transport.NewStatefulHost("http", tests.GetLocalhost() + ":{{port}}", call.IsReadWrite),{{/customHosts}} },
     {{/hasCustomHosts}}
     {{#gzipEncoding}}
     Compression: compression.GZIP,

templates/java/tests/client/createClient.mustache

@@ -1 +1 @@
-{{^autoCreateClient}}{{client}} client = {{/autoCreateClient}}new {{client}}("{{parametersWithDataTypeMap.appId.value}}","{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}},"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}{{#useEchoRequester}},withEchoRequester(){{/useEchoRequester}}{{#hasCustomHosts}},withCustomHosts(Arrays.asList({{#customHosts}}new Host("{{host}}", EnumSet.of(CallType.READ, CallType.WRITE), "http", {{port}}){{^-last}},{{/-last}}{{/customHosts}}), {{gzipEncoding}}){{/hasCustomHosts}});
+{{^autoCreateClient}}{{client}} client = {{/autoCreateClient}}new {{client}}("{{parametersWithDataTypeMap.appId.value}}","{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}},"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}{{#useEchoRequester}},withEchoRequester(){{/useEchoRequester}}{{#hasCustomHosts}},withCustomHosts(Arrays.asList({{#customHosts}}new Host("true".equals(System.getenv("CI")) ? "localhost" : "host.docker.internal", EnumSet.of(CallType.READ, CallType.WRITE), "http", {{port}}){{^-last}},{{/-last}}{{/customHosts}}), {{gzipEncoding}}){{/hasCustomHosts}});

templates/javascript/tests/client/createClient.mustache

@@ -1 +1 @@
-{{^autoCreateClient}}const client = {{/autoCreateClient}}{{client}}('{{parametersWithDataTypeMap.appId.value}}','{{parametersWithDataTypeMap.apiKey.value}}',{{#hasRegionalHost}}'{{parametersWithDataTypeMap.region.value}}',{{/hasRegionalHost}}{ {{#useEchoRequester}}requester: nodeEchoRequester(),{{/useEchoRequester}}{{#hasCustomHosts}}hosts:[{{#customHosts}}{ url: '{{host}}', port: {{port}}, accept: 'readWrite', protocol: 'http' },{{/customHosts}}]{{/hasCustomHosts}} });
+{{^autoCreateClient}}const client = {{/autoCreateClient}}{{client}}('{{parametersWithDataTypeMap.appId.value}}','{{parametersWithDataTypeMap.apiKey.value}}',{{#hasRegionalHost}}'{{parametersWithDataTypeMap.region.value}}',{{/hasRegionalHost}}{ {{#useEchoRequester}}requester: nodeEchoRequester(),{{/useEchoRequester}}{{#hasCustomHosts}}hosts:[{{#customHosts}}{ url: 'localhost', port: {{port}}, accept: 'readWrite', protocol: 'http' },{{/customHosts}}]{{/hasCustomHosts}} });

templates/kotlin/tests/client/createClient.mustache

@@ -1 +1 @@
-{{^autoCreateClient}}val client = {{/autoCreateClient}}{{client}}(appId = "{{parametersWithDataTypeMap.appId.value}}", apiKey = "{{parametersWithDataTypeMap.apiKey.value}}",{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}}"{{parametersWithDataTypeMap.region.value}}",{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}{{#hasCustomHosts}}options = ClientOptions(hosts = listOf({{#customHosts}}Host(url = "{{host}}", protocol = "http", port = {{port}}){{^-last}},{{/-last}}{{/customHosts}}){{#gzipEncoding}}, compressionType = CompressionType.GZIP{{/gzipEncoding}}){{/hasCustomHosts}})
+{{^autoCreateClient}}val client = {{/autoCreateClient}}{{client}}(appId = "{{parametersWithDataTypeMap.appId.value}}", apiKey = "{{parametersWithDataTypeMap.apiKey.value}}",{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}}"{{parametersWithDataTypeMap.region.value}}",{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}{{#hasCustomHosts}}options = ClientOptions(hosts = listOf({{#customHosts}}Host(url = if (System.getenv("CI") == "true") "localhost" else "host.docker.internal", protocol = "http", port = {{port}}){{^-last}},{{/-last}}{{/customHosts}}){{#gzipEncoding}}, compressionType = CompressionType.GZIP{{/gzipEncoding}}){{/hasCustomHosts}})

templates/kotlin/tests/client/tests.mustache

@@ -11,7 +11,7 @@ fun `{{#lambda.replaceBacktick}}{{{testName}}}{{/lambda.replaceBacktick}}`() = r
     {{#isError}}
     assertFails { 
         {{#dynamicTemplate}}{{/dynamicTemplate}}
-    }.let { error ->  assertError(error, "{{{expectedError}}}") }
+    }.let { error ->  assertError(error, "{{{expectedError}}}".replace("%localhost%", if (System.getenv("CI") == "true") "localhost" else "host.docker.internal")) }
     {{/isError}}
     {{^isError}}
     {{#isCreateClient}}

templates/php/tests/client/createClient.mustache

@@ -5,5 +5,5 @@ $client = $this->createClient(
     {{#parametersWithDataTypeMap.region}}"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{^parametersWithDataTypeMap.region}}null{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}
 );
 {{^isError}}$this->assertIsObject($client);{{/isError}}{{/useEchoRequester}}{{#hasCustomHosts}}
-$client = {{client}}::createWithConfig({{clientPrefix}}Config::create("{{parametersWithDataTypeMap.appId.value}}","{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}},"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}})->setFullHosts([{{#customHosts}}"http://{{host}}:{{port}}"{{^-last}},{{/-last}}{{/customHosts}}]));
+$client = {{client}}::createWithConfig({{clientPrefix}}Config::create("{{parametersWithDataTypeMap.appId.value}}","{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}},"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}})->setFullHosts([{{#customHosts}}"http://" . (getenv("CI") == "true" ? "localhost" : "host.docker.internal") . ":{{port}}"{{^-last}},{{/-last}}{{/customHosts}}]));
 {{/hasCustomHosts}}

templates/python/tests/client/createClient.mustache

@@ -1,5 +1,5 @@
 _config = {{#lambda.pascalcase}}{{clientPrefix}}Config{{/lambda.pascalcase}}("{{parametersWithDataTypeMap.appId.value}}", "{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}},"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}})
         {{#hasCustomHosts}}
-        {{#isError}}    {{/isError}}_config.hosts = HostsCollection([{{#customHosts}}Host(url='{{host}}', scheme='http', port={{port}}){{^-last}},{{/-last}}{{/customHosts}}])
+        {{#isError}}    {{/isError}}_config.hosts = HostsCollection([{{#customHosts}}Host(url='localhost' if environ.get('CI') == 'true' else 'host.docker.internal', scheme='http', port={{port}}){{^-last}},{{/-last}}{{/customHosts}}])
         {{/hasCustomHosts}}
         {{#isError}}    {{/isError}}_client = {{#lambda.pascalcase}}{{{client}}}{{/lambda.pascalcase}}{{#isSyncClient}}Sync{{/isSyncClient}}.create_with_config(config=_config{{#useEchoRequester}}, transporter=EchoTransporter{{#isSyncClient}}Sync{{/isSyncClient}}(_config){{/useEchoRequester}})

templates/ruby/tests/client/createClient.mustache

@@ -2,7 +2,7 @@
 client = Algolia::{{#lambda.pascalcase}}{{{client}}}{{/lambda.pascalcase}}.create_with_config(Algolia::Configuration.new(
   '{{parametersWithDataTypeMap.appId.value}}',
   '{{parametersWithDataTypeMap.apiKey.value}}',
-  [{{#customHosts}}Algolia::Transport::StatefulHost.new('{{host}}', protocol: 'http://', port: {{port}}, accept: CallType::READ | CallType::WRITE),{{/customHosts}}],
+  [{{#customHosts}}Algolia::Transport::StatefulHost.new(ENV.fetch('CI', nil) == 'true' ? 'localhost' : 'host.docker.internal', protocol: 'http://', port: {{port}}, accept: CallType::READ | CallType::WRITE),{{/customHosts}}],
   '{{client}}'{{#gzipEncoding}},
   compression_type: 'gzip'{{/gzipEncoding}}
 )){{/hasCustomHosts}}{{^hasCustomHosts}}

templates/ruby/tests/client/tests.mustache

@@ -18,7 +18,7 @@
       {{#dynamicTemplate}}{{/dynamicTemplate}}
       assert(false, 'An error should have been raised')
     rescue => e
-      assert_equal({{#lambda.codeSnakeCase}}'{{{expectedError}}}'{{/lambda.codeSnakeCase}}, e.message)
+      assert_equal({{#lambda.codeSnakeCase}}'{{{expectedError}}}'{{/lambda.codeSnakeCase}}.sub('%localhost%', ENV.fetch('CI', nil) == 'true' ? 'localhost' : 'host.docker.internal'), e.message)
     end
     {{/isError}}
     {{^isError}}

templates/scala/tests/client/createClient.mustache

@@ -6,7 +6,7 @@ val client = {{client}}(
         {{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}} region = {{#fallbackToAliasHost}}Option({{/fallbackToAliasHost}}"{{value}}"{{#fallbackToAliasHost}}){{/fallbackToAliasHost}},{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}
         clientOptions = ClientOptions
           .builder()
-          .withHosts(List({{#customHosts}}Host("{{host}}", Set(CallType.Read, CallType.Write), "http", Option({{port}})){{^-last}},{{/-last}}{{/customHosts}}))
+          .withHosts(List({{#customHosts}}Host(if (System.getenv("CI") == "true") "localhost" else "host.docker.internal", Set(CallType.Read, CallType.Write), "http", Option({{port}})){{^-last}},{{/-last}}{{/customHosts}}))
           {{#gzipEncoding}}.withCompressionType(CompressionType.Gzip){{/gzipEncoding}}
           .build()
       )

templates/swift/tests/client/createClient.mustache

@@ -1,3 +1,3 @@
-let configuration = try {{client}}Configuration(appID: "{{parametersWithDataTypeMap.appId.value}}", apiKey: "{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}, region: {{#parametersWithDataTypeMap.region}}Region(rawValue: "{{parametersWithDataTypeMap.region.value}}"){{/parametersWithDataTypeMap.region}}{{^parametersWithDataTypeMap.region}}nil{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}{{#hasCustomHosts}}, hosts: [{{#customHosts}}RetryableHost(url: URL(string: "http://{{host}}:{{port}}")!){{^-last}}, {{/-last}}{{/customHosts}}]{{/hasCustomHosts}}{{#gzipEncoding}}, compression: .gzip{{/gzipEncoding}})
+let configuration = try {{client}}Configuration(appID: "{{parametersWithDataTypeMap.appId.value}}", apiKey: "{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}, region: {{#parametersWithDataTypeMap.region}}Region(rawValue: "{{parametersWithDataTypeMap.region.value}}"){{/parametersWithDataTypeMap.region}}{{^parametersWithDataTypeMap.region}}nil{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}{{#hasCustomHosts}}, hosts: [{{#customHosts}}RetryableHost(url: URL(string: "http://" + (ProcessInfo.processInfo.environment["CI"] == "true" ? "localhost" : "host.docker.internal") + ":{{port}}")!){{^-last}}, {{/-last}}{{/customHosts}}]{{/hasCustomHosts}}{{#gzipEncoding}}, compression: .gzip{{/gzipEncoding}})
 let transporter: Transporter = Transporter(configuration: configuration{{#useEchoRequester}}, requestBuilder: EchoRequestBuilder(){{/useEchoRequester}})
 {{^autoCreateClient}}let client = {{/autoCreateClient}}{{client}}(configuration: configuration, transporter: transporter)

tests/CTS/benchmark/search/benchmark.json

@@ -10,7 +10,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6682
             }
           ]

tests/CTS/client/common/setClientApiKey.json

@@ -11,7 +11,6 @@
           "region": "us",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6683
             }
           ]

tests/CTS/client/search/api.json

@@ -82,15 +82,12 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6676
             },
             {
-              "host": "${{localhost}}",
               "port": 6677
             },
             {
-              "host": "${{localhost}}",
               "port": 6678
             }
           ]
@@ -122,7 +119,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6676
             }
           ]
@@ -144,7 +140,7 @@
             "kotlin": "Error(s) while processing the retry strategy",
             "php": "Impossible to connect, please check your Algolia Application Id.",
             "python": "Unreachable hosts",
-            "ruby": "Unreachable hosts. Last error for ${{localhost}}: Net::ReadTimeout with #<TCPSocket:(closed)>",
+            "ruby": "Unreachable hosts. Last error for %localhost%: Net::ReadTimeout with #<TCPSocket:(closed)>",
             "scala": "Error(s) while processing the retry strategy",
             "swift": "All hosts are unreachable. You can use 'exposeIntermediateErrors: true' in the config to investigate."
           }
@@ -163,7 +159,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6678
             }
           ],

tests/CTS/client/search/deleteObjects.json

@@ -10,7 +10,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6680
             }
           ]

tests/CTS/client/search/indexExists.json

@@ -10,7 +10,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6681
             }
           ]
@@ -40,7 +39,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6681
             }
           ]
@@ -70,7 +68,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6681
             }
           ]
@@ -88,7 +85,7 @@
             "go": "API error [403] {\\\"message\\\":\\\"Invalid API key\\\"}",
             "java": "Status Code: 403 - {\\\"message\\\":\\\"Invalid API key\\\"}",
             "javascript": "Invalid API key",
-            "kotlin": "Client request(GET http://${{localhost}}:6681/1/indexes/indexExistsERROR/settings) invalid: 403 Forbidden. Text: \\\"{\\\"message\\\":\\\"Invalid API key\\\"}\\\"",
+            "kotlin": "Client request(GET http://%localhost%:6681/1/indexes/indexExistsERROR/settings) invalid: 403 Forbidden. Text: \\\"{\\\"message\\\":\\\"Invalid API key\\\"}\\\"",
             "php": "Invalid API key",
             "python": "Invalid API key",
             "ruby": "Invalid API key",

tests/CTS/client/search/partialUpdateObjects.json

@@ -10,7 +10,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6680
             }
           ]
@@ -59,7 +58,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6680
             }
           ]

tests/CTS/client/search/replaceAllObjects.json

@@ -10,7 +10,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6679
             }
           ]

tests/CTS/client/search/saveObjects.json

@@ -10,7 +10,6 @@
           "apiKey": "test-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6680
             }
           ]
@@ -58,7 +57,6 @@
           "apiKey": "wrong-api-key",
           "customHosts": [
             {
-              "host": "${{localhost}}",
               "port": 6680
             }
           ]
@@ -86,7 +84,7 @@
             "go": "API error [403] {\\\"message\\\":\\\"Invalid Application-ID or API key\\\",\\\"status\\\":403}",
             "java": "Status Code: 403 - {\\\"message\\\":\\\"Invalid Application-ID or API key\\\",\\\"status\\\":403}",
             "javascript": "Invalid Application-ID or API key",
-            "kotlin": "Client request(POST http://${{localhost}}:6680/1/indexes/cts_e2e_saveObjects_kotlin/batch) invalid: 403 Forbidden. Text: \\\"{\\\"message\\\":\\\"Invalid Application-ID or API key\\\",\\\"status\\\":403}\\\"",
+            "kotlin": "Client request(POST http://%localhost%:6680/1/indexes/cts_e2e_saveObjects_kotlin/batch) invalid: 403 Forbidden. Text: \\\"{\\\"message\\\":\\\"Invalid Application-ID or API key\\\",\\\"status\\\":403}\\\"",
             "php": "Invalid Application-ID or API key",
             "python": "Invalid Application-ID or API key",
             "ruby": "Invalid Application-ID or API key",