Merge pull request #257 from cipherstash/feature/elixir-integration-test

yujiyokoo · web-flow · commit 32199aafd6e5 · 2025-06-09T09:36:17.000+09:00
Feature/elixir integration test
diff --git a/tests/integration/elixir_test/.formatter.exs b/tests/integration/elixir_test/.formatter.exs
@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]
diff --git a/tests/integration/elixir_test/.gitignore b/tests/integration/elixir_test/.gitignore
@@ -0,0 +1,26 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+elixir_test-*.tar
+
+# Temporary files, for example, from tests.
+/tmp/
diff --git a/tests/integration/elixir_test/README.md b/tests/integration/elixir_test/README.md
@@ -0,0 +1,13 @@
+# ElixirTest
+
+This directory contains the test project which uses ecto to run some integration tests.
+
+## Running
+
+The tests can be run using [mise](https://mise.jdx.dev/).
+
+From the project root directory, run:
+```
+test:integration:lang:elixir
+```
+
diff --git a/tests/integration/elixir_test/config/config.exs b/tests/integration/elixir_test/config/config.exs
@@ -0,0 +1,11 @@
+import Config
+
+config :elixir_test, ElixirTest.Repo,
+  database: "cipherstash",
+  username: "cipherstash",
+  port: 6432,
+  password: "p@ssword",
+  hostname: "proxy",
+  pool: Ecto.Adapters.SQL.Sandbox
+
+config :elixir_test, ecto_repos: [ElixirTest.Repo]
diff --git a/tests/integration/elixir_test/lib/elixir_test.ex b/tests/integration/elixir_test/lib/elixir_test.ex
@@ -0,0 +1,5 @@
+defmodule ElixirTest do
+  @moduledoc """
+  Top level module for `ElixirTest`.
+  """
+end
diff --git a/tests/integration/elixir_test/lib/elixir_test/application.ex b/tests/integration/elixir_test/lib/elixir_test/application.ex
@@ -0,0 +1,11 @@
+defmodule ElixirTest.Application do
+  def start(_type, _args) do
+    children = [
+      ElixirTest.Repo
+    ]
+
+    opts = [strategy: :one_for_one, name: ElixirTest.Supervisor]
+
+    Supervisor.start_link(children, opts)
+  end
+end
diff --git a/tests/integration/elixir_test/lib/elixir_test/encrypted.ex b/tests/integration/elixir_test/lib/elixir_test/encrypted.ex
@@ -0,0 +1,35 @@
+defmodule ElixirTest.Encrypted do
+  use Ecto.Schema
+  import Ecto.Changeset
+
+  @primary_key {:id, :id, autogenerate: false}
+  schema "encrypted" do
+    field(:plaintext, :string)
+    field(:plaintext_date, :date)
+    field(:encrypted_text, :string)
+    field(:encrypted_bool, :boolean)
+    field(:encrypted_int2, :integer)
+    field(:encrypted_int4, :integer)
+    field(:encrypted_int8, :integer)
+    field(:encrypted_float8, :float)
+    field(:encrypted_date, :date)
+    field(:encrypted_jsonb, :map)
+  end
+
+  def changeset(encrypted, attrs) do
+    encrypted
+    |> cast(attrs, [
+      :id,
+      :plaintext,
+      :plaintext_date,
+      :encrypted_text,
+      :encrypted_bool,
+      :encrypted_int2,
+      :encrypted_int4,
+      :encrypted_int8,
+      :encrypted_float8,
+      :encrypted_date,
+      :encrypted_jsonb
+    ])
+  end
+end
diff --git a/tests/integration/elixir_test/lib/elixir_test/repo.ex b/tests/integration/elixir_test/lib/elixir_test/repo.ex
@@ -0,0 +1,5 @@
+defmodule ElixirTest.Repo do
+  use Ecto.Repo,
+    otp_app: :elixir_test,
+    adapter: Ecto.Adapters.Postgres
+end
diff --git a/tests/integration/elixir_test/mix.exs b/tests/integration/elixir_test/mix.exs
@@ -0,0 +1,30 @@
+defmodule ElixirTest.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :elixir_test,
+      version: "0.1.0",
+      elixir: "~> 1.16",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger],
+      mod: {ElixirTest.Application, []}
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      {:ecto_sql, "~> 3.12"},
+      {:postgrex, "~> 0.20"},
+      {:jason, "~> 1.4"}
+    ]
+  end
+end
diff --git a/tests/integration/elixir_test/mix.lock b/tests/integration/elixir_test/mix.lock
@@ -0,0 +1,9 @@
+%{
+  "db_connection": {:hex, :db_connection, "2.7.0", "b99faa9291bb09892c7da373bb82cba59aefa9b36300f6145c5f201c7adf48ec", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "dcf08f31b2701f857dfc787fbad78223d61a32204f217f15e881dd93e4bdd3ff"},
+  "decimal": {:hex, :decimal, "2.3.0", "3ad6255aa77b4a3c4f818171b12d237500e63525c2fd056699967a3e7ea20f62", [:mix], [], "hexpm", "a4d66355cb29cb47c3cf30e71329e58361cfcb37c34235ef3bf1d7bf3773aeac"},
+  "ecto": {:hex, :ecto, "3.12.5", "4a312960ce612e17337e7cefcf9be45b95a3be6b36b6f94dfb3d8c361d631866", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "6eb18e80bef8bb57e17f5a7f068a1719fbda384d40fc37acb8eb8aeca493b6ea"},
+  "ecto_sql": {:hex, :ecto_sql, "3.12.1", "c0d0d60e85d9ff4631f12bafa454bc392ce8b9ec83531a412c12a0d415a3a4d0", [:mix], [{:db_connection, "~> 2.4.1 or ~> 2.5", [hex: :db_connection, repo: "hexpm", optional: false]}, {:ecto, "~> 3.12", [hex: :ecto, repo: "hexpm", optional: false]}, {:myxql, "~> 0.7", [hex: :myxql, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.19 or ~> 1.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:tds, "~> 2.1.1 or ~> 2.2", [hex: :tds, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.0 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "aff5b958a899762c5f09028c847569f7dfb9cc9d63bdb8133bff8a5546de6bf5"},
+  "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
+  "postgrex": {:hex, :postgrex, "0.20.0", "363ed03ab4757f6bc47942eff7720640795eb557e1935951c1626f0d303a3aed", [:mix], [{:db_connection, "~> 2.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "d36ef8b36f323d29505314f704e21a1a038e2dc387c6409ee0cd24144e187c0f"},
+  "telemetry": {:hex, :telemetry, "1.3.0", "fedebbae410d715cf8e7062c96a1ef32ec22e764197f70cda73d82778d61e7a2", [:rebar3], [], "hexpm", "7015fc8919dbe63764f4b4b87a95b7c0996bd539e0d499be6ec9d7f3875b79e6"},
+}
diff --git a/tests/integration/elixir_test/test/elixir_test_test.exs b/tests/integration/elixir_test/test/elixir_test_test.exs
@@ -0,0 +1,201 @@
+defmodule ElixirTestTest do
+  use ExUnit.Case
+  doctest ElixirTest
+  alias ElixirTest.Encrypted
+  alias ElixirTest.Repo
+  import Ecto.Query
+
+  setup do
+    :ok = Ecto.Adapters.SQL.Sandbox.checkout(Repo)
+    max_id = Repo.aggregate(Encrypted, :max, :id) || 1
+    %{next_id: max_id + 1}
+  end
+
+  test "db connection test" do
+    result = Ecto.Adapters.SQL.query!(Repo, "SELECT 1 as one")
+
+    assert result.rows == [[1]]
+  end
+
+  test "plaintext save and load", %{next_id: next_id} do
+    {:ok, result} =
+      %Encrypted{id: next_id, plaintext: "plaintext content", plaintext_date: ~D[2025-06-02]}
+      |> Repo.insert()
+
+    fetched = Encrypted |> Repo.get(result.id)
+
+    assert fetched.plaintext == "plaintext content"
+    assert fetched.plaintext_date == ~D[2025-06-02]
+  end
+
+  test "encrypted text save and load", %{next_id: next_id} do
+    {:ok, result} =
+      %Encrypted{id: next_id, encrypted_text: "encrypted text content"}
+      |> Repo.insert()
+
+    fetched = Encrypted |> Repo.get(result.id)
+
+    assert fetched.encrypted_text == "encrypted text content"
+  end
+
+  test "encrypted fields save and load", %{next_id: next_id} do
+    {:ok, result} =
+      %Encrypted{
+        id: next_id,
+        encrypted_bool: false,
+        encrypted_int2: 2,
+        encrypted_int4: 4,
+        encrypted_int8: 8,
+        encrypted_float8: 3.1415,
+        encrypted_date: ~D[2025-06-01],
+        encrypted_jsonb: %{top: %{array: [1, 2, 3]}}
+      }
+      |> Repo.insert()
+
+    fetched = Encrypted |> Repo.get(result.id)
+
+    assert !fetched.encrypted_bool
+    assert fetched.encrypted_int2 == 2
+    assert fetched.encrypted_int4 == 4
+    assert fetched.encrypted_int8 == 8
+    assert fetched.encrypted_float8 == 3.1415
+    assert fetched.encrypted_date == ~D[2025-06-01]
+    assert fetched.encrypted_jsonb == %{"top" => %{"array" => [1, 2, 3]}}
+  end
+
+  test "find by exact text", %{next_id: next_id} do
+    {2, _} =
+      Encrypted
+      |> Repo.insert_all([
+        %{id: next_id, encrypted_text: "encrypted text content"},
+        %{id: next_id + 1, encrypted_text: "some other encrypted text"}
+      ])
+
+    q =
+      from(e in "encrypted",
+        where: e.encrypted_text == "encrypted text content",
+        select: [e.encrypted_text]
+      )
+
+    fetched = Repo.all(q)
+
+    assert Enum.at(fetched, 0) == ["encrypted text content"]
+  end
+
+  test "find by text match", %{next_id: next_id} do
+    {2, _} =
+      Encrypted
+      |> Repo.insert_all([
+        %{id: next_id, encrypted_text: "encrypted text content"},
+        %{id: next_id + 1, encrypted_text: "some other encrypted text"}
+      ])
+
+    q =
+      from(e in "encrypted",
+        where: like(e.encrypted_text, "text cont"),
+        select: [e.encrypted_text]
+      )
+
+    fetched = Repo.all(q)
+
+    assert Enum.at(fetched, 0) == ["encrypted text content"]
+  end
+
+  test "find by float value - currently not supported", %{next_id: next_id} do
+    {2, _} =
+      Encrypted
+      |> Repo.insert_all([
+        %{id: next_id, encrypted_float8: 0.0},
+        %{id: next_id + 1, encrypted_float8: 7.5}
+      ])
+
+    # Ecto appends explicit cast to `7.5`, making it `7.5::float` and causes
+    # the "operator does not exist" error
+    q =
+      from(e in "encrypted",
+        where: e.encrypted_float8 == 7.5,
+        select: [e.id, e.encrypted_float8]
+      )
+
+    assert_raise(Postgrex.Error, fn -> Repo.all(q) end)
+  end
+
+  test "find by float value", %{next_id: next_id} do
+    {2, _} =
+      Encrypted
+      |> Repo.insert_all([
+        %{id: next_id, encrypted_float8: 0.0},
+        %{id: next_id + 1, encrypted_float8: 7.5}
+      ])
+
+    q =
+      from(e in "encrypted",
+        where: fragment("? = 7.5", e.encrypted_float8),
+        select: [e.id, e.encrypted_float8]
+      )
+
+    fetched = Repo.all(q)
+
+    assert Enum.at(fetched, 0) == [next_id + 1, 7.5]
+  end
+
+  test "find by float value gt", %{next_id: next_id} do
+    {2, _} =
+      Encrypted
+      |> Repo.insert_all([
+        %{id: next_id, encrypted_float8: 0.0},
+        %{id: next_id + 1, encrypted_float8: 7.5}
+      ])
+
+    q =
+      from(e in "encrypted",
+        where: fragment("? > 3.0", e.encrypted_float8),
+        select: [e.id, e.encrypted_float8]
+      )
+
+    fetched = Repo.all(q)
+
+    assert Enum.at(fetched, 0) == [next_id + 1, 7.5]
+  end
+
+  test "order by integer", %{next_id: next_id} do
+    {3, _} =
+      Encrypted
+      |> Repo.insert_all([
+        %{id: next_id, encrypted_int2: 7},
+        %{id: next_id + 1, encrypted_int2: 9},
+        %{id: next_id + 2, encrypted_int2: 0}
+      ])
+
+    q =
+      from(e in "encrypted",
+        order_by: e.encrypted_int2,
+        select: [e.encrypted_int2]
+      )
+
+    fetched = Repo.all(q) |> List.flatten()
+
+    assert fetched == [0, 7, 9]
+  end
+
+  test "find by text and float", %{next_id: next_id} do
+    {3, _} =
+      Encrypted
+      |> Repo.insert_all([
+        %{id: next_id, encrypted_text: "encrypted text content", encrypted_float8: 1.0},
+        %{id: next_id + 1, encrypted_text: "encrypted text content", encrypted_float8: 3.0},
+        %{id: next_id + 2, encrypted_text: "some other encrypted text", encrypted_float8: 5.0}
+      ])
+
+    q =
+      from(e in "encrypted",
+        where: like(e.encrypted_text, "text cont"),
+        where: fragment("? > 2.0", e.encrypted_float8),
+        select: [e.encrypted_text, e.encrypted_float8]
+      )
+
+    fetched = Repo.all(q)
+
+    assert Enum.at(fetched, 0) == ["encrypted text content", 3.0]
+  end
+end
diff --git a/tests/integration/elixir_test/test/test_helper.exs b/tests/integration/elixir_test/test/test_helper.exs
@@ -0,0 +1,2 @@
+ExUnit.start()
+Ecto.Adapters.SQL.Sandbox.mode(ElixirTest.Repo, :manual)
diff --git a/tests/tasks/test/integration/lang/docker-compose-elixir.yml b/tests/tasks/test/integration/lang/docker-compose-elixir.yml
@@ -0,0 +1,8 @@
+services:
+  elixir_test:
+    image: elixir:1.18
+    volumes:
+      - ./integration/elixir_test:/src
+    working_dir: /src
+    networks:
+      - postgres
diff --git a/tests/tasks/test/integration/lang/elixir.sh b/tests/tasks/test/integration/lang/elixir.sh
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+#MISE description="Run Elixir integration tests for Proxy"
+
+#!/bin/bash
+
+set -e
+
+echo "-------------------------------------"
+echo "Starting Elixir tests"
+echo "-------------------------------------"
+
+mise --env tls run postgres:up --extra-args "--detach --wait"
+mise --env tls run postgres:setup
+mise --env tls run proxy:down proxy-tls
+mise --env tls run proxy:up --extra-args "--detach --wait"
+
+docker compose -f tests/docker-compose.yml \
+  -f tests/tasks/test/integration/lang/docker-compose-elixir.yml \
+  run elixir_test bash -c "mix local.hex --force && mix deps.get && mix test"
+
diff --git a/tests/tasks/test/integration/lang/golang.sh b/tests/tasks/test/integration/lang/golang.sh

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +# Used by "mix format"
 +[
 +  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
 +]