Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reinstate deployment version check when device connects #1918

Merged
merged 3 commits into from
Feb 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions lib/nerves_hub/deployments.ex
Original file line number Diff line number Diff line change
Expand Up @@ -399,24 +399,28 @@ defmodule NervesHub.Deployments do
defp version_match?(_device, _deployment), do: true

@spec verify_deployment_membership(Device.t()) :: Device.t()
def verify_deployment_membership(%Device{deployment_id: deployment_id} = device)
def verify_deployment_membership(
%Device{deployment_id: deployment_id, firmware_metadata: %{version: device_version}} =
device
)
when not is_nil(deployment_id) do
{:ok, deployment} = get_deployment_for_device(device)

bad_architecture = device.firmware_metadata.architecture != deployment.firmware.architecture
bad_version = !Version.match?(device_version, deployment.conditions["version"])
bad_platform = device.firmware_metadata.platform != deployment.firmware.platform
bad_architecture = device.firmware_metadata.architecture != deployment.firmware.architecture

reason =
cond do
bad_architecture and bad_platform ->
"mismatched architecture and platform"

bad_architecture ->
"mismatched architecture"
bad_version ->
"mismatched version"

bad_platform ->
"mismatched platform"

bad_architecture ->
"mismatched architecture"

true ->
nil
end
Expand Down
36 changes: 35 additions & 1 deletion test/nerves_hub/deployments_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ defmodule NervesHub.DeploymentsTest do
assert device.deployment_id
end

test "removes device from deployment and creates audit log when conditions aren't met", %{
test "removes device from deployment and creates audit log when platforms don't match", %{
device: device,
deployment: deployment
} do
Expand All @@ -336,5 +336,39 @@ defmodule NervesHub.DeploymentsTest do
[audit_log] = AuditLogs.logs_for(deployment)
assert audit_log.description =~ "no longer matches deployment"
end

test "removes device from deployment and creates audit log when architecture doesn't match",
%{
device: device,
deployment: deployment
} do
{:ok, device} =
device
|> Devices.update_deployment(deployment)
|> Devices.update_firmware_metadata(%{"architecture" => "foobar"})

device = Deployments.verify_deployment_membership(device)
refute device.deployment_id

[audit_log] = AuditLogs.logs_for(deployment)
assert audit_log.description =~ "no longer matches deployment"
end

test "removes device from deployment and creates audit log when versions don't match",
%{
device: device,
deployment: deployment
} do
{:ok, device} =
device
|> Devices.update_deployment(deployment)
|> Devices.update_firmware_metadata(%{"version" => "1.0.1"})

device = Deployments.verify_deployment_membership(device)
refute device.deployment_id

[audit_log] = AuditLogs.logs_for(deployment)
assert audit_log.description =~ "no longer matches deployment"
end
end
end
13 changes: 8 additions & 5 deletions test/nerves_hub_web/channels/websocket_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,7 @@ defmodule NervesHubWeb.WebsocketTest do
Fixtures.deployment_fixture(org, firmware, %{
name: "a different name",
conditions: %{
"version" => "<= 1.0.0",
"tags" => ["beta"]
}
})
Expand Down Expand Up @@ -745,7 +746,7 @@ defmodule NervesHubWeb.WebsocketTest do
Fixtures.deployment_fixture(org, firmware, %{
name: "Every Device",
conditions: %{
"version" => "~> 0.0.1",
"version" => "<= 1.0.0",
"tags" => ["beta", "beta-edge"]
}
})
Expand Down Expand Up @@ -773,14 +774,13 @@ defmodule NervesHubWeb.WebsocketTest do

{:ok, socket} = SocketClient.start_link(@socket_config)

different_architecture = "arm"
different_platform = "tester"

SocketClient.join_and_wait(socket, %{
"device_api_version" => "2.2.0",
"nerves_fw_uuid" => Ecto.UUID.generate(),
"nerves_fw_product" => "test",
"nerves_fw_architecture" => different_architecture,
"nerves_fw_architecture" => device.firmware_metadata.architecture,
"nerves_fw_platform" => different_platform,
"nerves_fw_version" => "0.1.0"
})
Expand All @@ -790,7 +790,7 @@ defmodule NervesHubWeb.WebsocketTest do
[log, _, _] = AuditLogs.logs_by(device)

assert log.description ==
"Device no longer matches deployment Every Device's requirements because of mismatched architecture and platform"
"Device no longer matches deployment Every Device's requirements because of mismatched platform"

close_socket_cleanly(socket)
end
Expand All @@ -813,7 +813,7 @@ defmodule NervesHubWeb.WebsocketTest do
Fixtures.deployment_fixture(org, firmware, %{
name: "a different name",
conditions: %{
"version" => "~> 0.0.1",
"version" => "<= 1.0.0",
"tags" => ["beta", "beta-edge"]
}
})
Expand Down Expand Up @@ -1042,6 +1042,7 @@ defmodule NervesHubWeb.WebsocketTest do
Fixtures.deployment_fixture(org, firmware, %{
name: "beta",
conditions: %{
"version" => "<= 1.0.0",
"tags" => ["beta"]
},
archive_id: archive.id
Expand Down Expand Up @@ -1091,6 +1092,7 @@ defmodule NervesHubWeb.WebsocketTest do
Fixtures.deployment_fixture(org, firmware, %{
name: "beta",
conditions: %{
"version" => "<= 1.0.0",
"tags" => ["beta"]
},
archive_id: archive.id
Expand Down Expand Up @@ -1144,6 +1146,7 @@ defmodule NervesHubWeb.WebsocketTest do
Fixtures.deployment_fixture(org, firmware, %{
name: "beta",
conditions: %{
"version" => "<= 1.0.0",
"tags" => ["beta"]
}
})
Expand Down
Loading