Dialyzer and credo fixes (#1831)

Author: joshk

lib/nerves_hub/audit_logs.ex

@@ -16,6 +16,8 @@ defmodule NervesHub.AuditLogs do
     AuditLog.build(actor, resource, description)
     |> AuditLog.changeset()
     |> Repo.insert!()
+
+    :ok
   end
 
   def audit_with_ref!(actor, resource, description, reference_id) do

lib/nerves_hub/audit_logs/templates/deployment_templates.ex

@@ -4,43 +4,42 @@ defmodule NervesHub.AuditLogs.DeploymentTemplates do
   """
   alias NervesHub.Accounts.User
   alias NervesHub.AuditLogs
-  alias NervesHub.AuditLogs.AuditLog
   alias NervesHub.Deployments.Deployment
   alias NervesHub.Devices.Device
 
-  @spec audit_deployment_created(User.t(), Deployment.t()) :: AuditLog.t()
+  @spec audit_deployment_created(User.t(), Deployment.t()) :: :ok
   def audit_deployment_created(user, deployment) do
     description = "User #{user.name} created deployment #{deployment.name}"
     AuditLogs.audit!(user, deployment, description)
   end
 
-  @spec audit_deployment_updated(User.t(), Deployment.t()) :: AuditLog.t()
+  @spec audit_deployment_updated(User.t(), Deployment.t()) :: :ok
   def audit_deployment_updated(user, deployment) do
     description = "User #{user.name} updated deployment #{deployment.name}"
     AuditLogs.audit!(user, deployment, description)
   end
 
-  @spec audit_deployment_deleted(User.t(), Deployment.t()) :: AuditLog.t()
+  @spec audit_deployment_deleted(User.t(), Deployment.t()) :: :ok
   def audit_deployment_deleted(user, deployment) do
     description = "User #{user.name} deleted deployment #{deployment.name}"
     AuditLogs.audit!(user, deployment, description)
   end
 
-  @spec audit_deployment_toggle_active(User.t(), Deployment.t(), String.t()) :: AuditLog.t()
+  @spec audit_deployment_toggle_active(User.t(), Deployment.t(), String.t()) :: :ok
   def audit_deployment_toggle_active(user, deployment, status) do
     description = "User #{user.name} marked deployment #{deployment.name} #{status}"
     AuditLogs.audit!(user, deployment, description)
   end
 
-  @spec audit_deployment_mismatch(Device.t(), Deployment.t(), String.t()) :: AuditLog.t()
+  @spec audit_deployment_mismatch(Device.t(), Deployment.t(), String.t()) :: :ok
   def audit_deployment_mismatch(device, deployment, reason) do
     description =
       "Device no longer matches deployment #{deployment.name}'s requirements because of #{reason}"
 
     AuditLogs.audit!(device, deployment, description)
   end
 
-  @spec audit_deployment_change(Deployment.t(), String.t()) :: AuditLog.t()
+  @spec audit_deployment_change(Deployment.t(), String.t()) :: :ok
   def audit_deployment_change(deployment, change_string) do
     description = "Deployment #{deployment.name} #{change_string}"
     AuditLogs.audit!(deployment, deployment, description)

lib/nerves_hub/audit_logs/templates/device_templates.ex

@@ -2,60 +2,59 @@ defmodule NervesHub.AuditLogs.DeviceTemplates do
   @moduledoc """
   Templates for and handling of audit logging for device operations.
   """
-  alias NervesHub.Firmwares.Firmware
   alias NervesHub.Accounts.User
   alias NervesHub.AuditLogs
-  alias NervesHub.AuditLogs.AuditLog
   alias NervesHub.Deployments.Deployment
   alias NervesHub.Devices.Device
+  alias NervesHub.Firmwares.Firmware
 
   require Logger
 
   ## General
 
-  @spec audit_reboot(User.t(), Device.t()) :: AuditLog.t()
+  @spec audit_reboot(User.t(), Device.t()) :: :ok
   def audit_reboot(user, device) do
     description = "User #{user.name} rebooted device #{device.identifier}"
     AuditLogs.audit!(user, device, description)
   end
 
-  @spec audit_request_action(User.t(), Device.t(), String.t()) :: AuditLog.t()
+  @spec audit_request_action(User.t(), Device.t(), String.t()) :: :ok
   def audit_request_action(user, device, action) do
     description = "User #{user.name} requested the device (#{device.identifier}) #{action}"
     AuditLogs.audit!(user, device, description)
   end
 
   ## Firmware and upgrades
 
-  @spec audit_update_attempt(Device.t()) :: AuditLog.t()
+  @spec audit_update_attempt(Device.t()) :: :ok
   def audit_update_attempt(device) do
     description = "Device #{device.identifier} is attempting to update"
     AuditLogs.audit(device, device, description)
   end
 
-  @spec audit_pushed_available_update(User.t(), Device.t(), Deployment.t()) :: AuditLog.t()
+  @spec audit_pushed_available_update(User.t(), Device.t(), Deployment.t()) :: :ok
   def audit_pushed_available_update(user, device, deployment) do
     description =
       "User #{user.name} pushed available firmware update #{deployment.firmware.version} #{deployment.firmware.uuid} to device #{device.identifier}"
 
     AuditLogs.audit!(user, device, description)
   end
 
-  @spec audit_firmware_pushed(User.t(), Device.t(), Firmware.t()) :: AuditLog.t()
+  @spec audit_firmware_pushed(User.t(), Device.t(), Firmware.t()) :: :ok
   def audit_firmware_pushed(user, device, firmware) do
     description =
       "User #{user.name} pushed firmware #{firmware.version} #{firmware.uuid} to device #{device.identifier}"
 
     AuditLogs.audit!(user, device, description)
   end
 
-  @spec audit_firmware_metadata_updated(Device.t()) :: AuditLog.t()
+  @spec audit_firmware_metadata_updated(Device.t()) :: :ok
   def audit_firmware_metadata_updated(device) do
     description = "Device #{device.identifier} updated firmware metadata"
     AuditLogs.audit!(device, device, description)
   end
 
-  @spec audit_firmware_upgrade_blocked(Deployment.t(), Device.t()) :: AuditLog.t()
+  @spec audit_firmware_upgrade_blocked(Deployment.t(), Device.t()) :: :ok
   def audit_firmware_upgrade_blocked(deployment, device) do
     description = """
     Device #{device.identifier} automatically blocked firmware upgrades for #{deployment.penalty_timeout_minutes} minutes.
@@ -65,15 +64,15 @@ defmodule NervesHub.AuditLogs.DeviceTemplates do
     AuditLogs.audit!(deployment, device, description)
   end
 
-  @spec audit_firmware_updated(Device.t()) :: AuditLog.t()
+  @spec audit_firmware_updated(Device.t()) :: :ok
   def audit_firmware_updated(device) do
     description =
       "Device #{device.identifier} firmware set to version #{device.firmware_metadata.version} (#{device.firmware_metadata.uuid})"
 
     AuditLogs.audit!(device, device, description)
   end
 
-  @spec audit_device_deployment_update_triggered(Device.t(), UUIDv7.t()) :: AuditLog.t()
+  @spec audit_device_deployment_update_triggered(Device.t(), UUIDv7.t()) :: :ok
   def audit_device_deployment_update_triggered(device, reference_id) do
     deployment = device.deployment
     firmware = deployment.firmware
@@ -84,7 +83,7 @@ defmodule NervesHub.AuditLogs.DeviceTemplates do
     AuditLogs.audit_with_ref!(deployment, device, description, reference_id)
   end
 
-  @spec audit_device_deployment_update(User.t(), Device.t(), Deployment.t()) :: AuditLog.t()
+  @spec audit_device_deployment_update(User.t(), Device.t(), Deployment.t()) :: :ok
   def audit_device_deployment_update(user, device, deployment) do
     AuditLogs.audit!(
       user,
@@ -93,8 +92,7 @@ defmodule NervesHub.AuditLogs.DeviceTemplates do
     )
   end
 
-  @spec audit_device_deployment_update(Device.t(), Deployment.t(), :one_found | :multiple_found) ::
-          AuditLog.t()
+  @spec audit_set_deployment(Device.t(), Deployment.t(), :one_found | :multiple_found) :: :ok
   def audit_set_deployment(device, deployment, :one_found) do
     AuditLogs.audit!(
       device,
@@ -103,8 +101,6 @@ defmodule NervesHub.AuditLogs.DeviceTemplates do
     )
   end
 
-  @spec audit_set_deployment(Device.t(), Deployment.t(), :one_found | :multiple_found) ::
-          AuditLog.t()
   def audit_set_deployment(device, deployment, :multiple_found) do
     AuditLogs.audit!(
       device,

lib/nerves_hub/audit_logs/templates/product_templates.ex

@@ -1,27 +1,26 @@
 defmodule NervesHub.AuditLogs.ProductTemplates do
-  alias NervesHub.AuditLogs
-  alias NervesHub.AuditLogs.AuditLog
   alias NervesHub.Accounts.User
+  alias NervesHub.AuditLogs
   alias NervesHub.Products.Product
   alias NervesHub.Scripts.Script
 
-  @spec audit_script_created(User.t(), Product.t(), Script.t()) :: AuditLog.t()
+  @spec audit_script_created(User.t(), Product.t(), Script.t()) :: :ok
   def audit_script_created(user, product, script) do
     description =
       "User #{user.name} created script named #{script.name} with id #{script.id} for product #{product.name}"
 
     AuditLogs.audit!(user, product, description)
   end
 
-  @spec audit_script_created(User.t(), Product.t(), Script.t()) :: AuditLog.t()
+  @spec audit_script_created(User.t(), Product.t(), Script.t()) :: :ok
   def audit_script_updated(user, product, script) do
     description =
       "User #{user.name} updated script named #{script.name} with id #{script.id} for product #{product.name}"
 
     AuditLogs.audit!(user, product, description)
   end
 
-  @spec audit_script_deleted(User.t(), Product.t(), Script.t()) :: AuditLog.t()
+  @spec audit_script_deleted(User.t(), Product.t(), Script.t()) :: :ok
   def audit_script_deleted(user, product, script) do
     description =
       "User #{user.name} removed script named #{script.name} from product #{product.name}"

lib/nerves_hub/devices.ex

@@ -101,7 +101,7 @@ defmodule NervesHub.Devices do
     |> Repo.one!()
   end
 
-  @spec filter(%Product{}, map()) :: %{
+  @spec filter(Product.t(), map()) :: %{
           entries: list(Device.t()),
           current_page: non_neg_integer(),
           page_size: non_neg_integer(),

test/support/fixtures.ex

@@ -5,7 +5,7 @@ defmodule NervesHub.Fixtures do
   alias NervesHub.Accounts.Org
   alias NervesHub.Accounts.OrgKey
   alias NervesHub.Archives
-  alias NervesHub.AuditLogs
+  alias NervesHub.AuditLogs.AuditLog
   alias NervesHub.Certificate
   alias NervesHub.Deployments
   alias NervesHub.Devices
@@ -406,11 +406,13 @@ defmodule NervesHub.Fixtures do
     Enum.map(0..(days_to_add - 1), fn days ->
       inserted_at = NaiveDateTime.shift(now, day: -days)
 
-      AuditLogs.audit!(
+      AuditLog.build(
         %Devices.Device{id: device_id},
         %Devices.Device{id: device_id, org_id: org_id},
         "Updating"
       )
+      |> AuditLog.changeset()
+      |> Repo.insert!()
       |> Ecto.Changeset.change(%{inserted_at: inserted_at})
       |> Repo.update!()
     end)