Add installation_source field to the host telemetry (#728)

* Add installation_source field to the host telemetry

* Set the installation_source in a fixed enum

* Upcast version of the changed events

* Add event upcasting tests

* Remove not needed default values from commands ane events

* Split the host event upcasting test to individual files

lib/trento/application/integration/discovery/payloads/host_discovery_payload.ex

@@ -16,5 +16,22 @@ defmodule Trento.Integration.Discovery.HostDiscoveryPayload do
     field :total_memory_mb, :integer
     field :socket_count, :integer
     field :os_version, :string
+
+    field :installation_source, Ecto.Enum,
+      values: [:community, :suse, :unknown],
+      default: :unknown
+  end
+
+  def changeset(host, attrs) do
+    modified_attrs = installation_source_to_downcase(attrs)
+
+    host
+    |> cast(modified_attrs, fields())
+    |> validate_required_fields(@required_fields)
   end
+
+  defp installation_source_to_downcase(%{"installation_source" => installation_source} = attrs),
+    do: %{attrs | "installation_source" => String.downcase(installation_source)}
+
+  defp installation_source_to_downcase(attrs), do: attrs
 end

lib/trento/application/integration/discovery/policies/host_policy.ex

@@ -78,7 +78,8 @@ defmodule Trento.Integration.Discovery.HostPolicy do
          cpu_count: cpu_count,
          total_memory_mb: total_memory_mb,
          socket_count: socket_count,
-         os_version: os_version
+         os_version: os_version,
+         installation_source: installation_source
        }),
        do:
          RegisterHost.new(%{
@@ -90,7 +91,8 @@ defmodule Trento.Integration.Discovery.HostPolicy do
            cpu_count: cpu_count,
            total_memory_mb: total_memory_mb,
            socket_count: socket_count,
-           os_version: os_version
+           os_version: os_version,
+           installation_source: installation_source
          })
 
   defp build_update_provider_command(agent_id, %CloudDiscoveryPayload{

lib/trento/application/integration/telemetry/adapter/suse.ex

@@ -53,6 +53,7 @@ defmodule Trento.Integration.Telemetry.Suse do
         socket_count: &1.socket_count,
         total_memory_mb: &1.total_memory_mb,
         cloud_provider: &1.provider,
+        agent_installation_source: &1.installation_source,
         time: &1.updated_at
       }
     )

lib/trento/application/projectors/telemetry_projector.ex

@@ -23,7 +23,8 @@ defmodule Trento.TelemetryProjector do
       cpu_count: cpu_count,
       total_memory_mb: total_memory_mb,
       socket_count: socket_count,
-      os_version: sles_version
+      os_version: sles_version,
+      installation_source: installation_source
     },
     fn multi ->
       changeset =
@@ -34,7 +35,8 @@ defmodule Trento.TelemetryProjector do
           cpu_count: cpu_count,
           socket_count: socket_count,
           total_memory_mb: total_memory_mb,
-          sles_version: sles_version
+          sles_version: sles_version,
+          installation_source: installation_source
         })
 
       Ecto.Multi.insert(multi, :host_telemetry, changeset,
@@ -51,7 +53,8 @@ defmodule Trento.TelemetryProjector do
       cpu_count: cpu_count,
       socket_count: socket_count,
       total_memory_mb: total_memory_mb,
-      os_version: sles_version
+      os_version: sles_version,
+      installation_source: installation_source
     },
     fn multi ->
       changeset =
@@ -62,7 +65,8 @@ defmodule Trento.TelemetryProjector do
           cpu_count: cpu_count,
           socket_count: socket_count,
           total_memory_mb: total_memory_mb,
-          sles_version: sles_version
+          sles_version: sles_version,
+          installation_source: installation_source
         })
 
       Ecto.Multi.insert(multi, :host_telemetry, changeset,

lib/trento/application/read_models/host_telemetry_read_model.ex

@@ -18,6 +18,11 @@ defmodule Trento.HostTelemetryReadModel do
     field :socket_count, :integer
     field :total_memory_mb, :integer
     field :sles_version, :string
+
+    field :installation_source, Ecto.Enum,
+      values: [:community, :suse, :unknown],
+      default: :unknown
+
     field :provider, Ecto.Enum, values: [:azure, :aws, :gcp, :unknown]
 
     timestamps()

lib/trento/domain/host/commands/register_host.ex

@@ -17,5 +17,7 @@ defmodule Trento.Domain.Commands.RegisterHost do
     field :total_memory_mb, :integer
     field :socket_count, :integer
     field :os_version, :string, default: "Unknown"
+
+    field :installation_source, Ecto.Enum, values: [:community, :suse, :unknown]
   end
 end

lib/trento/domain/host/events/host_details_updated.ex

@@ -5,7 +5,7 @@ defmodule Trento.Domain.Events.HostDetailsUpdated do
 
   use Trento.Event
 
-  defevent do
+  defevent version: 2 do
     field :host_id, Ecto.UUID
     field :hostname, :string
     field :ip_addresses, {:array, :string}
@@ -15,5 +15,9 @@ defmodule Trento.Domain.Events.HostDetailsUpdated do
     field :total_memory_mb, :integer
     field :socket_count, :integer
     field :os_version, :string
+
+    field :installation_source, Ecto.Enum, values: [:community, :suse, :unknown]
   end
+
+  def upcast(params, _, 2), do: Map.put(params, "installation_source", :unknown)
 end

lib/trento/domain/host/events/host_registered.ex

@@ -5,7 +5,7 @@ defmodule Trento.Domain.Events.HostRegistered do
 
   use Trento.Event
 
-  defevent do
+  defevent version: 2 do
     field :host_id, Ecto.UUID
     field :hostname, :string
     field :ip_addresses, {:array, :string}
@@ -15,6 +15,11 @@ defmodule Trento.Domain.Events.HostRegistered do
     field :total_memory_mb, :integer
     field :socket_count, :integer
     field :os_version, :string
+
+    field :installation_source, Ecto.Enum, values: [:community, :suse, :unknown]
+
     field :heartbeat, Ecto.Enum, values: [:unknown]
   end
+
+  def upcast(params, _, 2), do: Map.put(params, "installation_source", :unknown)
 end

lib/trento/domain/host/host.ex

@@ -37,6 +37,7 @@ defmodule Trento.Domain.Host do
     :total_memory_mb,
     :socket_count,
     :os_version,
+    :installation_source,
     :heartbeat,
     :subscriptions,
     :provider_data
@@ -53,6 +54,7 @@ defmodule Trento.Domain.Host do
           total_memory_mb: non_neg_integer(),
           socket_count: non_neg_integer(),
           os_version: String.t(),
+          installation_source: :community | :suse | :unknown,
           subscriptions: [SlesSubscription.t()],
           provider_data: AwsProvider.t() | AzureProvider.t() | GcpProvider.t() | nil,
           heartbeat: :passing | :critical | :unknown
@@ -70,7 +72,8 @@ defmodule Trento.Domain.Host do
           cpu_count: cpu_count,
           total_memory_mb: total_memory_mb,
           socket_count: socket_count,
-          os_version: os_version
+          os_version: os_version,
+          installation_source: installation_source
         }
       ) do
     %HostRegistered{
@@ -83,6 +86,7 @@ defmodule Trento.Domain.Host do
       total_memory_mb: total_memory_mb,
       socket_count: socket_count,
       os_version: os_version,
+      installation_source: installation_source,
       heartbeat: :unknown
     }
   end
@@ -97,7 +101,8 @@ defmodule Trento.Domain.Host do
           cpu_count: cpu_count,
           total_memory_mb: total_memory_mb,
           socket_count: socket_count,
-          os_version: os_version
+          os_version: os_version,
+          installation_source: installation_source
         },
         %RegisterHost{
           hostname: hostname,
@@ -107,7 +112,8 @@ defmodule Trento.Domain.Host do
           cpu_count: cpu_count,
           total_memory_mb: total_memory_mb,
           socket_count: socket_count,
-          os_version: os_version
+          os_version: os_version,
+          installation_source: installation_source
         }
       ) do
     []
@@ -124,7 +130,8 @@ defmodule Trento.Domain.Host do
           cpu_count: cpu_count,
           total_memory_mb: total_memory_mb,
           socket_count: socket_count,
-          os_version: os_version
+          os_version: os_version,
+          installation_source: installation_source
         }
       ) do
     %HostDetailsUpdated{
@@ -136,7 +143,8 @@ defmodule Trento.Domain.Host do
       cpu_count: cpu_count,
       total_memory_mb: total_memory_mb,
       socket_count: socket_count,
-      os_version: os_version
+      os_version: os_version,
+      installation_source: installation_source
     }
   end
 
@@ -232,6 +240,7 @@ defmodule Trento.Domain.Host do
           total_memory_mb: total_memory_mb,
           socket_count: socket_count,
           os_version: os_version,
+          installation_source: installation_source,
           heartbeat: heartbeat
         }
       ) do
@@ -246,6 +255,7 @@ defmodule Trento.Domain.Host do
         total_memory_mb: total_memory_mb,
         socket_count: socket_count,
         os_version: os_version,
+        installation_source: installation_source,
         heartbeat: heartbeat
     }
   end
@@ -260,7 +270,8 @@ defmodule Trento.Domain.Host do
           cpu_count: cpu_count,
           total_memory_mb: total_memory_mb,
           socket_count: socket_count,
-          os_version: os_version
+          os_version: os_version,
+          installation_source: installation_source
         }
       ) do
     %Host{
@@ -272,7 +283,8 @@ defmodule Trento.Domain.Host do
         cpu_count: cpu_count,
         total_memory_mb: total_memory_mb,
         socket_count: socket_count,
-        os_version: os_version
+        os_version: os_version,
+        installation_source: installation_source
     }
   end
 

priv/repo/migrations/20220729073320_add_installation_source_host_telemetry_read_model.exs

@@ -0,0 +1,9 @@
+defmodule Trento.Repo.Migrations.AddInstallationSourceHostTelemetryReadModel do
+  use Ecto.Migration
+
+  def change do
+    alter table(:hosts_telemetry) do
+      add :installation_source, :string
+    end
+  end
+end

test/fixtures/discovery/host_discovery_with_installation_source.json

@@ -0,0 +1,15 @@
+{
+  "agent_id": "779cdd70-e9e2-58ca-b18a-bf3eb3f71244",
+  "discovery_type": "host_discovery",
+  "payload": {
+    "ssh_address": "10.2.2.22",
+    "os_version": "15-SP2",
+    "ip_addresses": ["10.1.1.4", "10.1.1.5", "10.1.1.6"],
+    "hostname": "suse",
+    "cpu_count": 2,
+    "socket_count": 1,
+    "total_memory_mb": 4096,
+    "agent_version": "0.1.0",
+    "installation_source": "Community"
+  }
+}

test/support/factory.ex

@@ -64,6 +64,7 @@ defmodule Trento.Factory do
       total_memory_mb: Enum.random(1..128),
       socket_count: Enum.random(1..16),
       os_version: Faker.App.semver(),
+      installation_source: Enum.random([:community, :suse, :unknown]),
       heartbeat: :unknown
     }
   end
@@ -78,7 +79,8 @@ defmodule Trento.Factory do
       cpu_count: Enum.random(1..16),
       total_memory_mb: Enum.random(1..128),
       socket_count: Enum.random(1..16),
-      os_version: Faker.App.semver()
+      os_version: Faker.App.semver(),
+      installation_source: Enum.random([:community, :suse, :unknown])
     }
   end
 
@@ -157,7 +159,8 @@ defmodule Trento.Factory do
       cpu_count: Enum.random(0..100),
       socket_count: Enum.random(0..100),
       total_memory_mb: Enum.random(0..100),
-      sles_version: Faker.App.version()
+      sles_version: Faker.App.version(),
+      installation_source: Enum.random([:community, :suse, :unknown])
     }
   end
 

test/trento/application/integration/discovery/policies/host_policy_test.exs

@@ -26,14 +26,31 @@ defmodule Trento.Integration.Discovery.HostPolicyTest do
                agent_version: "0.1.0",
                host_id: "779cdd70-e9e2-58ca-b18a-bf3eb3f71244",
                hostname: "suse",
-               ip_addresses: ["10.1.1.4", "10.1.1.5", "10.1.1.6"]
+               ip_addresses: ["10.1.1.4", "10.1.1.5", "10.1.1.6"],
+               installation_source: :unknown
              }
            } =
              "host_discovery"
              |> load_discovery_event_fixture()
              |> HostPolicy.handle()
   end
 
+  test "should return the expected commands when a host_discovery_with_installation_source payload is handled" do
+    assert {
+             :ok,
+             %RegisterHost{
+               agent_version: "0.1.0",
+               host_id: "779cdd70-e9e2-58ca-b18a-bf3eb3f71244",
+               hostname: "suse",
+               ip_addresses: ["10.1.1.4", "10.1.1.5", "10.1.1.6"],
+               installation_source: :community
+             }
+           } =
+             "host_discovery_with_installation_source"
+             |> load_discovery_event_fixture()
+             |> HostPolicy.handle()
+  end
+
   test "should return the expected commands when a cloud_discovery payload with an azure provider is handled" do
     assert {
              :ok,

test/trento/domain/host/events/host_details_updated_test.exs

@@ -0,0 +1,46 @@
+defmodule Trento.Domain.Events.HostDetailsUpdatedTest do
+  use Trento.AggregateCase, aggregate: Trento.Domain.Host, async: true
+
+  alias Trento.Domain.Events.HostDetailsUpdated
+
+  describe "HostDetailsUpdated event upcasting" do
+    test "should upcast HostDetailsUpdated event properly from version 1" do
+      host_id = Faker.UUID.v4()
+      hostname = Faker.StarWars.character()
+      ip_addresses = [Faker.Internet.ip_v4_address()]
+      ssh_address = Faker.Internet.ip_v4_address()
+      agent_version = Faker.Internet.slug()
+      cpu_count = Enum.random(1..16)
+      total_memory_mb = Enum.random(1..128)
+      socket_count = Enum.random(1..16)
+      os_version = Faker.App.version()
+
+      assert %HostDetailsUpdated{
+               version: 2,
+               host_id: host_id,
+               hostname: hostname,
+               ip_addresses: ip_addresses,
+               ssh_address: ssh_address,
+               agent_version: agent_version,
+               cpu_count: cpu_count,
+               total_memory_mb: total_memory_mb,
+               socket_count: socket_count,
+               os_version: os_version,
+               installation_source: :unknown
+             } ==
+               %{
+                 "host_id" => host_id,
+                 "hostname" => hostname,
+                 "ip_addresses" => ip_addresses,
+                 "ssh_address" => ssh_address,
+                 "agent_version" => agent_version,
+                 "cpu_count" => cpu_count,
+                 "total_memory_mb" => total_memory_mb,
+                 "socket_count" => socket_count,
+                 "os_version" => os_version
+               }
+               |> HostDetailsUpdated.upcast(%{})
+               |> HostDetailsUpdated.new!()
+    end
+  end
+end