force install tests

Author: Matthew Peck

config/config.exs

@@ -12,19 +12,6 @@ else
   config :cog, :access_rules, :enforcing
 end
 
-# ========================================================================
-# Set this to true to disable bundle version checking. Cog will overwrite
-# bundles with the same version instead of requiring a new version number.
-# NOTE: This should only ever be set for development. Setting this in a
-# production environment could cause unexpected behavior.
-# ========================================================================
-
-if System.get_env("DISABLE_BUNDLE_VERSION_ENFORCEMENT") do
-  config :cog, :enforce_bundle_version, false
-else
-  config :cog, :enforce_bundle_version, true
-end
-
 # ========================================================================
 # Embedded Command Bundle Version (for built-in commands)
 # NOTE: Do not change this value unless you know what you're doing.

test/cog/repository/bundles_test.exs

@@ -145,6 +145,72 @@ defmodule Cog.Repository.BundlesTest do
     assert {:error, {:db_errors, [version: {"has already been taken", []}]}} = Bundles.install(%{"name" => "testing", "version" => "1.0.0", "config_file" => %{}})
   end
 
+  describe "forced bundle installation" do
+
+    setup [:forced_installation_configs]
+
+    test "installing the same version overwrites the original version", %{old_config: config}  do
+      {:ok, _version} = Bundles.install(%{"name" => config["name"], "version" => config["version"], "config_file" => config})
+
+      assert {:ok, _overwritten_version} = Bundles.install(:force, %{"name" => config["name"], "version" => config["version"], "config_file" => config})
+    end
+
+    test "different configs persist properly", %{old_config: old_config, new_config: new_config} do
+
+      {:ok, orig_version} = Bundles.install(%{"name" => old_config["name"],
+                                              "version" => old_config["version"],
+                                              "config_file" => old_config})
+
+      # Make sure the bundle installs
+      assert {:ok, new_version} = Bundles.install(:force, %{"name" => new_config["name"],
+                                                            "version" => new_config["version"],
+                                                            "config_file" => new_config})
+
+      new_version = Repo.preload(new_version, :templates)
+
+      # Make sure the bundle name and version didn't change
+      assert orig_version.bundle.name == new_version.bundle.name
+      assert orig_version.version == new_version.version
+
+      # Check the config file
+      assert new_version.config_file == new_config
+
+      # Check commands
+      expected_command_names = Map.keys(new_config["commands"]) |> Enum.sort
+      actual_command_names = Enum.map(new_version.commands, &(&1.command.name)) |> Enum.sort
+      assert actual_command_names == expected_command_names
+
+      # Check permissions
+      expected_permissions = new_config["permissions"] |> Enum.sort
+      actual_permissions = Enum.map(new_version.permissions, &("test_bundle:#{&1.name}")) |> Enum.sort
+      assert actual_permissions == expected_permissions
+
+      # Check templates
+      expected_template_names = Map.keys(new_config["templates"]) |> Enum.sort
+      actual_template_names = Enum.map(new_version.templates, &(&1.name)) |> Enum.sort
+      assert actual_template_names == expected_template_names
+
+      expected_templates = Enum.map(new_config["templates"], fn({_, source}) -> source["body"] end) |> Enum.sort
+      actual_templates = Enum.map(new_version.templates, &(&1.source)) |> Enum.sort
+      assert actual_templates == expected_templates
+    end
+
+    test "maintains enabled status", %{old_config: old_config, new_config: new_config} do
+      {:ok, orig_version} = Bundles.install(%{"name" => old_config["name"],
+                                              "version" => old_config["version"],
+                                              "config_file" => old_config})
+
+      :ok = Bundles.set_bundle_version_status(orig_version, :enabled)
+
+      {:ok, new_version} = Bundles.install(:force, %{"name" => new_config["name"],
+                                                     "version" => new_config["version"],
+                                                     "config_file" => new_config})
+
+      assert Bundles.enabled?(new_version)
+    end
+
+  end
+
   test "deleting the last version of a bundle deletes the bundle itself" do
     {:ok, version} = Bundles.install(%{"name" => "testing", "version" => "1.0.0", "config_file" => %{}})
 
@@ -404,4 +470,50 @@ defmodule Cog.Repository.BundlesTest do
     v
   end
 
+  # Setup function for testing forced bundle installations
+  defp forced_installation_configs(context) do
+    old_config =
+      %{"cog_bundle_version" => 4,
+        "name" => "test_bundle",
+        "description" => "A test bundle",
+        "version" => "0.1.0",
+        "permissions" => ["test_bundle:date", "test_bundle:time"],
+        "docker" => %{"image" => "operable-bundle/test_bundle",
+                      "tag" => "v0.1.0"},
+        "commands" => %{"date" => %{"executable" => "/usr/local/bin/date",
+                                    "options" => %{"option1" => %{"type" => "string",
+                                                                  "description" => "An option",
+                                                                  "required" => false,
+                                                                  "short_flag" => "o"}},
+                                    "rules" => ["when command is test_bundle:date must have test_bundle:date"]},
+                        "time" => %{"executable" => "/usr/local/bin/time",
+                                    "rules" => ["when command is test_bundle:time must have test_bundle:time"]}},
+        "templates" => %{"time" => %{"body" => "~$results[0].time~"},
+                         "date" => %{"body" => "~$results[0].date~"}}}
+
+    new_config =
+      %{"cog_bundle_version" => 4,
+        "name" => "test_bundle",
+        "description" => "An updated test bundle",
+        "version" => "0.1.0",
+        "permissions" => ["test_bundle:new_date", "test_bundle:new_time", "test_bundle:another_command"],
+        "docker" => %{"image" => "operable-bundle/test_bundle_update",
+                      "tag" => "v0.1.1"},
+        "commands" => %{"new_date" => %{"executable" => "/usr/local/bin/date",
+                                        "options" => %{"option1" => %{"type" => "string",
+                                                                      "description" => "An option",
+                                                                      "required" => false,
+                                                                      "short_flag" => "o"}},
+                                        "rules" => ["when command is test_bundle:date must have test_bundle:date"]},
+                        "new_time" => %{"executable" => "/usr/local/bin/time",
+                                        "rules" => ["when command is test_bundle:time must have test_bundle:time"]},
+                        "another_command" => %{"executable" => "/usr/local/bin/time",
+                                               "rules" => ["when command is test_bundle:time must have test_bundle:time"]}},
+        "templates" => %{"new_time" => %{"body" => "~$results[0].new_time~"},
+                         "new_date" => %{"body" => "~$results[0].new_date~"},
+                         "another" => %{"body" => "~$results[0].another~"}}}
+
+    Map.merge(context, %{old_config: old_config, new_config: new_config})
+  end
+
 end

test/controllers/v1/bundles_controller_test.exs

@@ -134,117 +134,6 @@ defmodule Cog.V1.BundlesControllerTest do
             "version has already been taken"] = json_response(conn, 409)["errors"]
   end
 
-  test "Overwrites an installed version when bundle version enforcement is disabled", %{authed: requestor} do
-    Application.put_env(:cog, :enforce_bundle_version, false)
-
-    config = config(:map)
-    conn = api_request(requestor, :post, "/v1/bundles", body: %{"bundle" => %{"config" => config}})
-    assert response(conn, 201)
-
-    # Now try to do the same thing again
-    conn = api_request(requestor, :post, "/v1/bundles", body: %{"bundle" => %{"config" => config}})
-
-    bundle_version_id = Poison.decode!(conn.resp_body)
-                        |> get_in(["bundle_version", "id"])
-
-    bundle_version = Cog.Repository.Bundles.version(bundle_version_id)
-
-    assert conn.status == 201
-    assert bundle_version.config_file == config
-    assert bundle_version.bundle.name == config["name"]
-
-    Application.put_env(:cog, :enforce_bundle_version, true)
-  end
-
-  test "Overwrite an installed version with a bundle that resembles the old only in name and version number", %{authed: requestor} do
-    Application.put_env(:cog, :enforce_bundle_version, false)
-
-    # Make the original request
-    config = config(:map)
-    conn = api_request(requestor, :post, "/v1/bundles", body: %{"bundle" => %{"config" => config}})
-    assert response(conn, 201)
-
-    # Change everything about the config except the bundle name and version number
-    new_config = Spanner.Config.Parser.read_from_string!(overwrite_bundle_test_config)
-
-    # Make the request with the new config
-    conn = api_request(requestor, :post, "/v1/bundles", body: %{"bundle" => %{"config" => new_config}})
-    assert conn.status == 201
-
-    # Grab the new bundle version from the db
-    bundle_version = Poison.decode!(conn.resp_body)
-                     |> get_in(["bundle_version", "id"])
-                     |> Cog.Repository.Bundles.version
-                     |> Repo.preload(:templates)
-
-    # Make our assertions
-    assert bundle_version.config_file == new_config
-    assert bundle_version.bundle.name == config["name"]
-
-    expected_command_names = Map.keys(new_config["commands"]) |> Enum.sort
-    actual_command_names = Enum.map(bundle_version.commands, &(&1.command.name)) |> Enum.sort
-    assert actual_command_names == expected_command_names
-
-    expected_permissions = new_config["permissions"] |> Enum.sort
-    actual_permissions = Enum.map(bundle_version.permissions, &("test_bundle:#{&1.name}")) |> Enum.sort
-    assert actual_permissions == expected_permissions
-
-    expected_template_names = Enum.map(new_config["templates"], fn({name, _}) -> name end) |> Enum.sort
-    actual_template_names = Enum.map(bundle_version.templates, &(&1.name)) |> Enum.sort
-    assert actual_template_names == expected_template_names
-
-    expected_templates = Enum.map(new_config["templates"], fn({_, source}) -> source["body"] end) |> Enum.sort
-    actual_templates = Enum.map(bundle_version.templates, &(&1.source)) |> Enum.sort
-    assert actual_templates == expected_templates
-
-    Application.put_env(:cog, :enforce_bundle_version, true)
-  end
-
-  defp overwrite_bundle_test_config do
-    """
-    ---
-    # Format version
-    cog_bundle_version: 4
-
-    name: test_bundle
-    description: A test bundle
-    version: "0.1.0"
-    permissions:
-    - test_bundle:new_date
-    - test_bundle:new_time
-    - test_bundle:another_command
-    docker:
-      image: operable-bundle/test_bundle_update
-      tag: v0.1.1
-    commands:
-      new_date:
-        executable: /usr/local/bin/new_date
-        description: A new date command
-        arguments: "[format]"
-        options:
-          new_option1:
-            type: string
-            description: A different option
-            required: true
-            short_flag: a
-        rules:
-        - when command is test_bundle:new_date must have test_bundle:new_date
-      new_time:
-        executable: /usr/local/bin/new_time
-        rules:
-        - when command is test_bundle:new_time must have test_bundle:new_time
-      another_command:
-        executable: /usr/local/bin/another_command
-        rules:
-        - when command is test_bundle:another_command must have test_bundle:another_command
-    templates:
-      time:
-        body: ~$results[0].time~
-      date:
-        body: ~$results[0].date~
-    """
-  end
-
   test "fails to install with semantically invalid config", %{authed: requestor} do
     # The config includes rules that mention permissions; if we remove
     # those permissions, installation should fail