Implement Structure.dump_cmd/3 and query_many/4 (#93)

* Implement Structure.dump_cmd/3
* Implement query_many/4 to raise exception
* Disable logging integration test

Co-authored-by: Jonatan Männchen <[email protected]> @maennchen

Author: warmwaffles

integration_test/all_test.exs

@@ -11,7 +11,7 @@ Code.require_file "#{ecto}/integration_test/cases/repo.exs", __DIR__
 
 ecto_sql = Mix.Project.deps_paths()[:ecto_sql]
 # Code.require_file "#{ecto_sql}/integration_test/sql/lock.exs", __DIR__
-Code.require_file "#{ecto_sql}/integration_test/sql/logging.exs", __DIR__
+# Code.require_file "#{ecto_sql}/integration_test/sql/logging.exs", __DIR__
 Code.require_file "#{ecto_sql}/integration_test/sql/sandbox.exs", __DIR__
 Code.require_file "#{ecto_sql}/integration_test/sql/sql.exs", __DIR__
 Code.require_file "#{ecto_sql}/integration_test/sql/stream.exs", __DIR__

integration_test/json_test.exs

@@ -8,7 +8,7 @@ defmodule Ecto.Integration.JsonTest do
 
   test "json_extract_path with primitive values" do
     order = %Order{
-      meta: %{
+      metadata: %{
         :id => 123,
         :time => ~T[09:00:00],
         "code" => "good",
@@ -21,67 +21,67 @@ defmodule Ecto.Integration.JsonTest do
 
     order = TestRepo.insert!(order)
 
-    assert TestRepo.one(from(o in Order, select: o.meta["id"])) == 123
-    assert TestRepo.one(from(o in Order, select: o.meta["bad"])) == nil
-    assert TestRepo.one(from(o in Order, select: o.meta["bad"]["bad"])) == nil
+    assert TestRepo.one(from(o in Order, select: o.metadata["id"])) == 123
+    assert TestRepo.one(from(o in Order, select: o.metadata["bad"])) == nil
+    assert TestRepo.one(from(o in Order, select: o.metadata["bad"]["bad"])) == nil
 
     field = "id"
-    assert TestRepo.one(from(o in Order, select: o.meta[^field])) == 123
-    assert TestRepo.one(from(o in Order, select: o.meta["time"])) == "09:00:00"
-    assert TestRepo.one(from(o in Order, select: o.meta["'single quoted'"])) == "bar"
-    assert TestRepo.one(from(o in Order, select: o.meta["';"])) == nil
-    assert TestRepo.one(from(o in Order, select: o.meta["\"double quoted\""])) == "baz"
-    assert TestRepo.one(from(o in Order, select: o.meta["enabled"])) == 1
-    assert TestRepo.one(from(o in Order, select: o.meta["extra"][0]["enabled"])) == 0
+    assert TestRepo.one(from(o in Order, select: o.metadata[^field])) == 123
+    assert TestRepo.one(from(o in Order, select: o.metadata["time"])) == "09:00:00"
+    assert TestRepo.one(from(o in Order, select: o.metadata["'single quoted'"])) == "bar"
+    assert TestRepo.one(from(o in Order, select: o.metadata["';"])) == nil
+    assert TestRepo.one(from(o in Order, select: o.metadata["\"double quoted\""])) == "baz"
+    assert TestRepo.one(from(o in Order, select: o.metadata["enabled"])) == 1
+    assert TestRepo.one(from(o in Order, select: o.metadata["extra"][0]["enabled"])) == 0
 
     # where
-    assert TestRepo.one(from(o in Order, where: o.meta["id"] == 123, select: o.id)) ==
+    assert TestRepo.one(from(o in Order, where: o.metadata["id"] == 123, select: o.id)) ==
              order.id
 
-    assert TestRepo.one(from(o in Order, where: o.meta["id"] == 456, select: o.id)) ==
+    assert TestRepo.one(from(o in Order, where: o.metadata["id"] == 456, select: o.id)) ==
              nil
 
-    assert TestRepo.one(from(o in Order, where: o.meta["code"] == "good", select: o.id)) ==
+    assert TestRepo.one(from(o in Order, where: o.metadata["code"] == "good", select: o.id)) ==
              order.id
 
-    assert TestRepo.one(from(o in Order, where: o.meta["code"] == "bad", select: o.id)) ==
+    assert TestRepo.one(from(o in Order, where: o.metadata["code"] == "bad", select: o.id)) ==
              nil
 
     assert TestRepo.one(
-             from(o in Order, where: o.meta["enabled"] == true, select: o.id)
+             from(o in Order, where: o.metadata["enabled"] == true, select: o.id)
            ) == order.id
 
     assert TestRepo.one(
              from(o in Order,
-               where: o.meta["extra"][0]["enabled"] == false,
+               where: o.metadata["extra"][0]["enabled"] == false,
                select: o.id
              )
            ) == order.id
   end
 
   test "json_extract_path with arrays and objects" do
-    order = %Order{meta: %{tags: [%{name: "red"}, %{name: "green"}]}}
+    order = %Order{metadata: %{tags: [%{name: "red"}, %{name: "green"}]}}
     order = TestRepo.insert!(order)
 
-    assert TestRepo.one(from(o in Order, select: o.meta["tags"][0]["name"])) == "red"
-    assert TestRepo.one(from(o in Order, select: o.meta["tags"][99]["name"])) == nil
+    assert TestRepo.one(from(o in Order, select: o.metadata["tags"][0]["name"])) == "red"
+    assert TestRepo.one(from(o in Order, select: o.metadata["tags"][99]["name"])) == nil
 
     index = 1
 
-    assert TestRepo.one(from(o in Order, select: o.meta["tags"][^index]["name"])) ==
+    assert TestRepo.one(from(o in Order, select: o.metadata["tags"][^index]["name"])) ==
              "green"
 
     # where
     assert TestRepo.one(
-             from(o in Order, where: o.meta["tags"][0]["name"] == "red", select: o.id)
+             from(o in Order, where: o.metadata["tags"][0]["name"] == "red", select: o.id)
            ) == order.id
 
     assert TestRepo.one(
-             from(o in Order, where: o.meta["tags"][0]["name"] == "blue", select: o.id)
+             from(o in Order, where: o.metadata["tags"][0]["name"] == "blue", select: o.id)
            ) == nil
 
     assert TestRepo.one(
-             from(o in Order, where: o.meta["tags"][99]["name"] == "red", select: o.id)
+             from(o in Order, where: o.metadata["tags"][99]["name"] == "red", select: o.id)
            ) == nil
   end
 

integration_test/test_helper.exs

@@ -114,6 +114,12 @@ ExUnit.start(
     # SQLite3 does not support placeholders
     :placeholders,
     # SQLite3 stores booleans as integers, causing Ecto's json_extract_path tests to fail
-    :json_extract_path
+    :json_extract_path,
+
+    # We don't support selected_as
+    :selected_as_with_group_by,
+    :selected_as_with_order_by,
+    :selected_as_with_order_by_expression,
+    :selected_as_with_having,
   ]
 )

lib/ecto/adapters/sqlite3.ex

@@ -247,6 +247,11 @@ defmodule Ecto.Adapters.SQLite3 do
     end
   end
 
+  @impl Ecto.Adapter.Structure
+  def dump_cmd(args, opts \\ [], config) when is_list(config) and is_list(args) do
+    run_with_cmd("sqlite3", [config[:database] | args], opts)
+  end
+
   @impl Ecto.Adapter.Schema
   def autogenerate(:id), do: nil
   def autogenerate(:embed_id), do: Ecto.UUID.generate()
@@ -487,12 +492,14 @@ defmodule Ecto.Adapters.SQLite3 do
     end
   end
 
-  defp run_with_cmd(cmd, args) do
+  defp run_with_cmd(cmd, args, cmd_opts \\ []) do
     unless System.find_executable(cmd) do
       raise "could not find executable `#{cmd}` in path, " <>
               "please guarantee it is available before running ecto commands"
     end
 
-    System.cmd(cmd, args, stderr_to_stdout: true)
+    cmd_opts = Keyword.put_new(cmd_opts, :stderr_to_stdout, true)
+
+    System.cmd(cmd, args, cmd_opts)
   end
 end

lib/ecto/adapters/sqlite3/connection.ex

@@ -95,6 +95,11 @@ defmodule Ecto.Adapters.SQLite3.Connection do
     end
   end
 
+  @impl true
+  def query_many(_conn, _sql, _params, _opts) do
+    raise RuntimeError, "query_many is not supported in the SQLite3 adapter"
+  end
+
   @impl true
   def stream(conn, sql, params, options) do
     query = Exqlite.Query.build(statement: sql)

test/ecto/adapters/sqlite3/connection_test.exs

@@ -70,7 +70,9 @@ defmodule Ecto.Adapters.SQLite3.ConnectionTest do
   end
 
   defp plan(query, operation \\ :all) do
-    {query, _params} = Ecto.Adapter.Queryable.plan_query(operation, SQLite3, query)
+    {query, _cast_params, _dump_params} =
+      Ecto.Adapter.Queryable.plan_query(operation, SQLite3, query)
+
     query
   end
 

test/ecto/adapters/sqlite3_test.exs

@@ -82,6 +82,24 @@ defmodule Ecto.Adapters.SQLite3Test do
     end
   end
 
+  describe "dump_cmd/3" do
+    test "runs command" do
+      opts = [database: Temp.path!()]
+
+      assert SQLite3.storage_up(opts) == :ok
+
+      assert {_out, 0} =
+               SQLite3.dump_cmd(
+                 ["CREATE TABLE test (id INTEGER PRIMARY KEY)"],
+                 [],
+                 opts
+               )
+
+      assert {"CREATE TABLE test (id INTEGER PRIMARY KEY);\n", 0} =
+               SQLite3.dump_cmd([".schema"], [], opts)
+    end
+  end
+
   defp string_uuid?(uuid), do: Regex.match?(@uuid_regex, uuid)
   defp binary_uuid?(uuid), do: bit_size(uuid) == 128
 end