From f80053f535051005e758e91456fdd9fe17873e20 Mon Sep 17 00:00:00 2001 From: "Kevin C. Baird" Date: Wed, 19 Aug 2015 13:17:04 -0400 Subject: [PATCH 1/5] Remove trailing whitespace --- lib/overseer/clusters/cluster_monitor.ex | 90 +++++++++---------- lib/overseer/clusters/clusters_monitor.ex | 16 ++-- .../clusters/fleet_manager_publisher.ex | 16 ++-- lib/overseer/components/component_mgr.ex | 34 +++---- .../components/component_status_mgr.ex | 12 +-- lib/overseer/components/components_mgr.ex | 8 +- lib/overseer/components/monitor_task.ex | 22 ++--- lib/overseer/components/upgrade_task.ex | 12 +-- lib/overseer/configuration.ex | 36 ++++---- lib/overseer/dispatcher.ex | 48 +++++----- lib/overseer/message_manager.ex | 12 +-- lib/overseer/modules/listener.ex | 14 +-- lib/overseer/modules/manager.ex | 22 ++--- lib/overseer/modules/retriever.ex | 12 +-- lib/overseer/supervisor.ex | 10 +-- 15 files changed, 182 insertions(+), 182 deletions(-) diff --git a/lib/overseer/clusters/cluster_monitor.ex b/lib/overseer/clusters/cluster_monitor.ex index 176e728..3ee7862 100644 --- a/lib/overseer/clusters/cluster_monitor.ex +++ b/lib/overseer/clusters/cluster_monitor.ex @@ -14,7 +14,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do @moduledoc """ This module contains the GenServer for monitoring a cluster in the associated exchange - """ + """ @doc """ Specific start_link implementation @@ -23,7 +23,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do {:ok, pid} | {:error, reason} """ - @spec start_link(Map) :: {:ok, pid} | {:error, String.t()} + @spec start_link(Map) :: {:ok, pid} | {:error, String.t()} def start_link(cluster) do Logger.debug("#{@logprefix}[#{cluster["etcd_token"]}] Starting...") GenServer.start_link(__MODULE__, %{cluster: cluster, etcd_token: cluster["etcd_token"]}) @@ -79,28 +79,28 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do handler = FleetManagerPublisher.list_machines!(etcd_token, exchange_id) case RpcHandler.get_response(handler) do {:error, reason} -> Logger.error("#{@logprefix}[#{etcd_token}] Received the following error retrieving node_info: #{inspect reason}") - {:ok, nil} -> + {:ok, nil} -> Logger.error("#{@logprefix}[#{etcd_token}] Unable to perform host checking...invalid hosts were found in exchange #{exchange_id}!") event = %{ unique: true, - type: :docker_disk_space_percent, - severity: :warning, + type: :docker_disk_space_percent, + severity: :warning, data: %{host_cnt: 0}, message: "EtcdCluster #{etcd_token} has no associated hosts" - } + } SystemEvent.create_system_event!(ManagerApi.get_api, event) - {:ok, []} -> + {:ok, []} -> Logger.error("#{@logprefix}[#{etcd_token}] Unable to perform host checking...no hosts were found in exchange #{exchange_id}!") event = %{ unique: true, - type: :docker_disk_space_percent, - severity: :warning, + type: :docker_disk_space_percent, + severity: :warning, data: %{host_cnt: 0}, message: "EtcdCluster #{etcd_token} has no associated hosts" - } - SystemEvent.create_system_event!(ManagerApi.get_api, event) + } + SystemEvent.create_system_event!(ManagerApi.get_api, event) {:ok, hosts} -> monitor_hosts(etcd_token, hosts) end end @@ -139,7 +139,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do """ @spec monitor_host([], Map, String.t) :: term def monitor_host([], _node_info, _etcd_token) do - Logger.debug("Finished reviewing node_info") + Logger.debug("Finished reviewing node_info") end @doc """ @@ -150,7 +150,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do The `hosts` option defines the list of hosts to review The `node_info` option defines the Map of all host information - + """ @spec monitor_host(List, Map, String.t) :: term def monitor_host([returned_hostname | remaining_hostnames], node_info, etcd_token) do @@ -158,11 +158,11 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do Logger.debug("Evaluating hostname #{returned_hostname} in node_info #{inspect node_info}") - event = cond do + event = cond do info["docker_disk_space_percent"] == nil -> %{ - unique: true, - type: :docker_disk_space_percent, - severity: :error, + unique: true, + type: :docker_disk_space_percent, + severity: :error, data: %{ docker_disk_space_percent: nil, hostname: returned_hostname, @@ -171,28 +171,28 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do message: "Host #{returned_hostname} is not reporting the Docker disk space utilization %!" } info["docker_disk_space_percent"] > 90 -> %{ - unique: true, - type: :docker_disk_space_percent, - severity: :error, + unique: true, + type: :docker_disk_space_percent, + severity: :error, data: %{ docker_disk_space_percent: info["docker_disk_space_percent"], hostname: returned_hostname, etcd_token: etcd_token }, message: "Host #{returned_hostname} is reporting a Docker disk space utilization of #{info["docker_disk_space_percent"]}%!" - } + } info["docker_disk_space_percent"] > 80 -> %{ unique: true, - type: :docker_disk_space_percent, - severity: :warning, + type: :docker_disk_space_percent, + severity: :warning, data: %{ docker_disk_space_percent: info["docker_disk_space_percent"], hostname: returned_hostname, etcd_token: etcd_token }, message: "Host #{returned_hostname} is reporting a Docker disk space utilization of #{info["docker_disk_space_percent"]}%!" - } - true -> nil + } + true -> nil end if event != nil do @@ -211,7 +211,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do ## Option Values The `etcd_token` option defines the EtcdToken associated with the cluster - + """ @spec monitor_cluster_units(String.t) :: term def monitor_cluster_units(etcd_token) do @@ -221,23 +221,23 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do case RpcHandler.get_response(handler) do {:error, reason} -> Logger.error("#{@logprefix}[#{etcd_token}] Received the following error retrieving unit states: #{inspect reason}") #i.e. build slaves - {:ok, []} -> Logger.debug("#{@logprefix}[#{etcd_token}] Cluster #{etcd_token} is not running any units") + {:ok, []} -> Logger.debug("#{@logprefix}[#{etcd_token}] Cluster #{etcd_token} is not running any units") #load error occurred - {:ok, nil} -> + {:ok, nil} -> Logger.error("#{@logprefix}[#{etcd_token}] Unable to perform states checking...invalid states were found in cluster #{etcd_token}!") event = %{ unique: true, - type: :failed_unit, - severity: :warning, + type: :failed_unit, + severity: :warning, data: %{ etcd_token: etcd_token, host_cnt: nil }, message: "EtcdCluster #{etcd_token} failed to return unit states!" - } - SystemEvent.create_system_event!(ManagerApi.get_api, event) - {:ok, units} -> + } + SystemEvent.create_system_event!(ManagerApi.get_api, event) + {:ok, units} -> monitor_unit_instances(units, etcd_token, 0) monitor_units(units, etcd_token) end @@ -253,7 +253,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do """ @spec monitor_unit_instances([], String.t, term) :: term def monitor_unit_instances([], _etcd_token, _failure_count) do - Logger.debug("Finished reviewing units") + Logger.debug("Finished reviewing units") end @doc """ @@ -266,23 +266,23 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do """ @spec monitor_unit_instances(List, String.t, term) :: term def monitor_unit_instances([unit| remaining_units] = all_units, etcd_token, failure_count) do - event = cond do + event = cond do #give failed units 3 tries before generating an error unit["systemdActiveState"] == "failed" && failure_count < 3 -> :timer.sleep(10_000) #TODO: need to refresh the unit state first monitor_unit_instances(all_units, etcd_token, failure_count + 1) unit["systemdActiveState"] == "failed" -> %{ - unique: true, - type: :failed_unit, - severity: :warning, + unique: true, + type: :failed_unit, + severity: :warning, data: %{ unit_name: unit["name"], etcd_token: etcd_token }, message: "Unit #{unit["name"]} is in a failed state!" - } - true -> nil + } + true -> nil end if event != nil do @@ -327,18 +327,18 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do running_units = units_by_name[unit_name] if length(running_units) == 0 do event = %{ - unique: true, - type: :failed_unit, - severity: :error, + unique: true, + type: :failed_unit, + severity: :error, data: %{ unit_name: unit_name, etcd_token: etcd_token }, message: "Unit #{unit_name} has no running instances!" - } + } Logger.error("#{@logprefix} A system event was generated for unit #{unit_name}: #{inspect event}") - SystemEvent.create_system_event!(ManagerApi.get_api, event) + SystemEvent.create_system_event!(ManagerApi.get_api, event) end end end diff --git a/lib/overseer/clusters/clusters_monitor.ex b/lib/overseer/clusters/clusters_monitor.ex index 6009e0b..34152b2 100644 --- a/lib/overseer/clusters/clusters_monitor.ex +++ b/lib/overseer/clusters/clusters_monitor.ex @@ -14,7 +14,7 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do @moduledoc """ This module contains the GenServer for monitoring all of the clusters in the associated exchange - """ + """ @doc """ Specific start_link implementation @@ -23,11 +23,11 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link() do Logger.debug("#{@logprefix} Starting...") case GenServer.start_link(__MODULE__, %{clusters: %{}}, name: __MODULE__) do - {:ok, pid} -> + {:ok, pid} -> if Application.get_env(:autostart, :clusters_monitor, true) do GenServer.cast(pid, {:monitor}) end @@ -96,10 +96,10 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do clusters = MessagingExchange.exchange_clusters!(ManagerApi.get_api, exchange_id) cond do - clusters == nil -> + clusters == nil -> Logger.error("#{@logprefix} Unable to load clusters associated with exchange #{exchange_id}!") state - clusters == [] -> + clusters == [] -> Logger.debug("#{@logprefix} There are no clusters associated to exchange #{exchange_id}") stop_monitoring_clusters(state) true -> @@ -126,19 +126,19 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do def monitor_cluster(state, cluster) do if state[:clusters][cluster["etcd_token"]] == nil do case ClusterMonitor.start_link(cluster) do - {:ok, monitor} -> + {:ok, monitor} -> Logger.debug("#{@logprefix} Starting a new monitor for cluster #{cluster["etcd_token"]}") cluster_cache = state[:clusters] cluster_cache = Map.put(cluster_cache, cluster["etcd_token"], monitor) Map.put(state, :clusters, cluster_cache) - {:error, reason} -> + {:error, reason} -> Logger.error("#{@logprefix} Failed to start Cluster monitor for cluster #{cluster["etcd_token"]}: #{inspect reason}") state end else Logger.debug("#{@logprefix} A monitor already exists for cluster #{cluster["etcd_token"]}") state - end + end end @doc """ diff --git a/lib/overseer/clusters/fleet_manager_publisher.ex b/lib/overseer/clusters/fleet_manager_publisher.ex index b606ef4..3701cdd 100644 --- a/lib/overseer/clusters/fleet_manager_publisher.ex +++ b/lib/overseer/clusters/fleet_manager_publisher.ex @@ -25,11 +25,11 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do {:ok, pid} | {:error, reason} """ - @spec start_link :: {:ok, pid} | {:error, String.t()} + @spec start_link :: {:ok, pid} | {:error, String.t()} def start_link do Logger.debug("Starting FleetManagerPublisher...") GenServer.start_link(__MODULE__, %{}, name: __MODULE__) - end + end @doc """ Method to retrieve the machines in a Cluster @@ -108,7 +108,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do {:error, reason} -> raise reason end end - + @doc """ Method to retrieve unit logs for a particular Unit in a cluster @@ -124,7 +124,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do RpcHandler pid """ - @spec unit_logs!(String.t(), term, String.t) :: pid + @spec unit_logs!(String.t(), term, String.t) :: pid def unit_logs!(etcd_token, cluster_exchange_id, unit_name) do request_body = %{ etcd_token: etcd_token, @@ -153,7 +153,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do RpcHandler pid """ - @spec node_info!(term, List) :: pid + @spec node_info!(term, List) :: pid def node_info!(cluster_exchange_id, nodes) do request_body = %{ action: :node_info, @@ -165,8 +165,8 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do case GenServer.call(__MODULE__, {:execute_rpc_request, request_body, cluster_exchange_id}) do {:ok, handler} -> handler {:error, reason} -> raise reason - end - end + end + end @spec handle_call({:execute_rpc_request, Map, term}, term, Map) :: {:reply, pid, Map} def handle_call({:execute_rpc_request, request_body, cluster_exchange_id}, _from, state) do @@ -178,7 +178,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do fleet_manager_queue = QueueBuilder.build(ManagerApi.get_api, "fleet_manager", cluster_exchange_id) connection_options = ConnectionOptionsResolver.resolve( - ManagerApi.get_api, + ManagerApi.get_api, Configuration.get_current_broker_id, Configuration.get_current_exchange_id, cluster_exchange_id diff --git a/lib/overseer/components/component_mgr.ex b/lib/overseer/components/component_mgr.ex index 1cb02a3..599138b 100644 --- a/lib/overseer/components/component_mgr.ex +++ b/lib/overseer/components/component_mgr.ex @@ -16,7 +16,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do @moduledoc """ This module contains the GenServer for managing a specific SystemComponent and kicking off upgrades as needed - """ + """ @doc """ Specific start_link implementation @@ -29,7 +29,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:ok, pid} | {:error, reason} """ - @spec start_link(Map) :: {:ok, pid} | {:error, String.t()} + @spec start_link(Map) :: {:ok, pid} | {:error, String.t()} def start_link(component) do Logger.debug("#{@logprefix}[#{component["type"]}] Starting...") case GenServer.start_link(__MODULE__, %{component: component, updated_at: Time.now()}) do @@ -62,7 +62,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do Map containing the refreshed component """ - @spec refresh(pid) :: Map + @spec refresh(pid) :: Map def refresh(mgr) do GenServer.call(mgr, {:refresh_component}) end @@ -78,7 +78,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do Map containing the cached component """ - @spec component(pid) :: Map + @spec component(pid) :: Map def component(mgr) do GenServer.call(mgr, {:get_component}) end @@ -139,7 +139,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do ## Option Values The `mgr` option is the GenServer PID - + ## Return Values the upgrade / monitoring async Task @@ -162,7 +162,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, component, state} """ - @spec handle_call({:get_component}, pid, Map) :: {:reply, Map, Map} + @spec handle_call({:get_component}, pid, Map) :: {:reply, Map, Map} def handle_call({:get_component}, _from, state) do {:reply, state[:component], state} end @@ -182,15 +182,15 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, updated_component or original if save fails, state} """ - @spec handle_call({:save, Map}, pid, Map) :: {:reply, Map, Map} + @spec handle_call({:save, Map}, pid, Map) :: {:reply, Map, Map} def handle_call({:save, updated_component}, _from, state) do - response = SystemComponent.update_system_component(ManagerApi.get_api, updated_component["id"], updated_component) + response = SystemComponent.update_system_component(ManagerApi.get_api, updated_component["id"], updated_component) if response.success? do Logger.debug("#{@logprefix}[#{updated_component["type"]}] Successfully saved updated_component #{updated_component["id"]}") state = Map.put(state, :component, updated_component) state = Map.put(state, :updated_at, Time.now()) - {:reply, updated_component, state} - else + {:reply, updated_component, state} + else Logger.error("#{@logprefix}[#{updated_component["type"]}] Failed to save updated_component #{updated_component["id"]}: #{inspect response}") {:reply, state[:component], state} end @@ -209,15 +209,15 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, updated component, state} """ - @spec handle_call({:refresh_component}, pid, Map) :: {:reply, Map, Map} + @spec handle_call({:refresh_component}, pid, Map) :: {:reply, Map, Map} def handle_call({:refresh_component}, _from, state) do case SystemComponent.get_system_component!(ManagerApi.get_api, state[:component]["id"]) do - nil -> + nil -> Logger.error("#{@logprefix}[#{state[:component]["type"]}] Failed to refresh component #{state[:component]["id"]}!") component -> Logger.debug("#{@logprefix}[#{component["type"]}] Successfully refreshed component #{component["id"]}") state = Map.put(state, :component, component) - state = Map.put(state, :updated_at, Time.now()) + state = Map.put(state, :updated_at, Time.now()) end {:reply, state[:component], state} @@ -246,17 +246,17 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do if state[:monitoring_task] != nil && !Process.alive?(state[:monitoring_task].pid) do Logger.debug("#{@logprefix}[#{state[:component]["type"]}] A zombie MonitoringTask has been found for #{state[:component]["id"]}; clearing saved MonitoringTask") - state = Map.put(state, :monitoring_task, nil) + state = Map.put(state, :monitoring_task, nil) end task = cond do - state[:monitoring_task] != nil -> + state[:monitoring_task] != nil -> Logger.debug("#{@logprefix}[#{state[:component]["type"]}] An upgrade has been requested for component #{state[:component]["id"]}; upgrade is currently being monitored.") state[:monitoring_task] - state[:upgrade_task] != nil -> + state[:upgrade_task] != nil -> Logger.debug("#{@logprefix}[#{state[:component]["type"]}] An upgrade has been requested for component #{state[:component]["id"]}; upgrade is currently in-progress.") state[:upgrade_task] - true -> + true -> Logger.debug("#{@logprefix}[#{state[:component]["type"]}] An upgrade has been requested for component #{state[:component]["id"]}; a new upgrade has been requested") UpgradeTask.create(self) end diff --git a/lib/overseer/components/component_status_mgr.ex b/lib/overseer/components/component_status_mgr.ex index 03c4ce4..8a591cd 100644 --- a/lib/overseer/components/component_status_mgr.ex +++ b/lib/overseer/components/component_status_mgr.ex @@ -12,7 +12,7 @@ defmodule OpenAperture.Overseer.Components.ComponentStatusMgr do @moduledoc """ This module contains the GenServer for a checking if upgrades need to be created - """ + """ @doc """ Specific start_link implementation @@ -21,7 +21,7 @@ defmodule OpenAperture.Overseer.Components.ComponentStatusMgr do {:ok, pid} | {:error, reason} """ - @spec start_link(pid) :: {:ok, pid} | {:error, String.t()} + @spec start_link(pid) :: {:ok, pid} | {:error, String.t()} def start_link(mgr) do case GenServer.start_link(__MODULE__, %{component_mgr: mgr}) do {:error, reason} -> {:error, reason} @@ -75,21 +75,21 @@ defmodule OpenAperture.Overseer.Components.ComponentStatusMgr do component["status"] == "upgrade_in_progress" -> Logger.debug("#{@logprefix}[#{component["type"]}] Component #{type} is not currently being monitored, but an upgrade is in progress. Requesting a MonitorTask...") #the component is being upgraded, ensure that we have some task running. If not, start a Monitoring task - #to resolve the current state + #to resolve the current state MonitorTask.create(state[:component_mgr]) #after 5 minutes, request another upgrade check (ensure the definition hasn't changed) :timer.sleep(300000) true -> Logger.debug("#{@logprefix}[#{component["type"]}] Component #{type} is not currently being monitored, reviewing for upgrade...") - - execute_upgrade = cond do + + execute_upgrade = cond do upgrade_strategy == :hourly -> Logger.debug("#{@logprefix}[#{component["type"]}] An hourly upgrade strategy has been defined for component #{type}") #pick a time randomly <= 1 hour :timer.sleep(:random.uniform(3600000)) true - true -> + true -> Logger.debug("#{@logprefix}[#{component["type"]}] A manual upgrade strategy has been defined for component #{type}") #after 5 minutes, request another upgrade check (ensure the definition hasn't changed) diff --git a/lib/overseer/components/components_mgr.ex b/lib/overseer/components/components_mgr.ex index 9398292..709efe9 100644 --- a/lib/overseer/components/components_mgr.ex +++ b/lib/overseer/components/components_mgr.ex @@ -13,7 +13,7 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do @moduledoc """ This module contains the GenServer for managing SystemComponents associated with the configured Exchange - """ + """ @doc """ Specific start_link implementation @@ -22,7 +22,7 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link() do Logger.debug("#{@logprefix} Starting...") @@ -72,7 +72,7 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do end @doc """ - Method for ensuring that a ComponentMgr exists for each type of Component assigned to + Method for ensuring that a ComponentMgr exists for each type of Component assigned to the current exchange ## Options @@ -99,7 +99,7 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do if updated_state[:managers][component["type"]] == nil do Logger.debug("#{@logprefix} There are #{length(components)} component(s) assigned to exchange #{exchange_id}") case ComponentMgr.start_link(component) do - {:error, reason} -> + {:error, reason} -> Logger.error("#{@logprefix} Failed to start a ComponentMgr for component #{component["type"]} (#{component["id"]}): #{inspect reason}") {:ok, mgr} -> managers = Map.put(updated_state[:managers], component["type"], mgr) diff --git a/lib/overseer/components/monitor_task.ex b/lib/overseer/components/monitor_task.ex index dd2dfc6..b7ef21f 100644 --- a/lib/overseer/components/monitor_task.ex +++ b/lib/overseer/components/monitor_task.ex @@ -12,7 +12,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do @moduledoc """ This module contains the Task for Monitoring an in-progress upgrade - """ + """ @doc """ Method to start a new MonitorTask @@ -27,7 +27,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do """ @spec create(pid) :: Task def create(mgr) do - Task.async(fn -> + Task.async(fn -> try do ComponentMgr.set_task(mgr, :monitoring_task, self) @@ -35,15 +35,15 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do :timer.sleep(60000) execute_monitoring(mgr) catch - :exit, code -> + :exit, code -> component = ComponentMgr.refresh(mgr) Logger.error("#{@logprefix}[#{component["type"]}] Monitoring component #{component["id"]} Exited with code #{inspect code}") ComponentMgr.set_task(mgr, :monitoring_task, nil) - :throw, value -> + :throw, value -> component = ComponentMgr.refresh(mgr) Logger.error("#{@logprefix}[#{component["type"]}] Monitoring component #{component["id"]} Throw called with #{inspect value}") ComponentMgr.set_task(mgr, :monitoring_task, nil) - what, value -> + what, value -> component = ComponentMgr.refresh(mgr) Logger.error("#{@logprefix}[#{component["type"]}] Monitoring component #{component["id"]} Caught #{inspect what} with #{inspect value}") ComponentMgr.set_task(mgr, :monitoring_task, nil) @@ -68,7 +68,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do case check_upgrade_status(mgr, component) do {:ok, :upgrade_completed} -> Logger.info("#{@logprefix}[#{component["type"]}] Upgrade monitoring task for type #{component["type"]} (#{component["id"]}) has completed in status :upgrade_completed") - + #save status upgrade_status = component["upgrade_status"] upgrade_status = Map.put(upgrade_status, "current_workflow", nil) @@ -83,7 +83,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do component = ComponentMgr.save(mgr, component) {:ok, status, current_workflow_id} -> Logger.info("#{@logprefix}[#{component["type"]}] Upgrade monitoring task for type #{component["type"]} (#{component["id"]}) is in status #{status}") - + #save status upgrade_status = component["upgrade_status"] upgrade_status = Map.put(upgrade_status, "current_workflow", current_workflow_id) @@ -93,7 +93,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do ComponentMgr.save(mgr, component) {:error, reason} -> Logger.error("#{@logprefix}[#{component["type"]}] Upgrade monitoring task for type #{component["type"]} (#{component["id"]}) has failed: #{inspect reason}") - + #save failure upgrade_status = component["upgrade_status"] upgrade_status = Map.put(upgrade_status, "failure_reason", "Upgrade monitoring task for type #{component["type"]} (#{component["id"]}) has failed: #{inspect reason}") @@ -124,7 +124,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do cond do #bad upgrade request - current_workflow == nil -> + current_workflow == nil -> {:error, "Invalid upgrade_status - no current workflow could be identified!"} #not started @@ -136,7 +136,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do false -> {:error, "Failed to execute the next Workflow - #{current_workflow["id"]}!"} true -> Logger.debug("#{@logprefix}[#{component["type"]}] Successfully executed the next Workflow - #{current_workflow["id"]}") - + #create another monitoring task MonitorTask.create(mgr) {:ok, :upgrade_in_progress, current_workflow["id"]} @@ -177,7 +177,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do else try do Enum.reduce upgrade_status["workflows"], nil, fn workflow_id, current_workflow -> - workflow = Workflow.get_workflow!(ManagerApi.get_api, workflow_id) + workflow = Workflow.get_workflow!(ManagerApi.get_api, workflow_id) cond do workflow == nil -> raise "An error occurred retrieving Workflow #{workflow_id}!" diff --git a/lib/overseer/components/upgrade_task.ex b/lib/overseer/components/upgrade_task.ex index 5ce6072..8f89df6 100644 --- a/lib/overseer/components/upgrade_task.ex +++ b/lib/overseer/components/upgrade_task.ex @@ -14,7 +14,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do @moduledoc """ This module contains the Task for executing an upgrade - """ + """ @doc """ Method to start a new UpgradeTask @@ -29,7 +29,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do """ @spec create(pid) :: Task def create(mgr) do - Task.async(fn -> + Task.async(fn -> try do ComponentMgr.set_task(mgr, :upgrade_task, self) execute_upgrade(mgr) @@ -72,7 +72,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do {true, ref_component} -> Logger.debug("#{@logprefix}[#{component["type"]}] Component #{type} is eligible for upgrade") case upgrade(mgr, component, ref_component) do - :ok -> + :ok -> #create a monitoring task Logger.debug("#{@logprefix}[#{component["type"]}] The upgrade has started successfully, creating a MonitoringTask...") MonitorTask.create(mgr) @@ -86,7 +86,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do component = Map.put(component, "status", "upgrade_failed") component = Map.put(component, "upgrade_status", upgrade_status) ComponentMgr.save(mgr, component) - Logger.debug("#{@logprefix}[#{component["type"]}] Upgrade task has completed") + Logger.debug("#{@logprefix}[#{component["type"]}] Upgrade task has completed") end end end @@ -176,7 +176,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do #save here so no other Overseer starts the upgrade component = ComponentMgr.save(mgr, component) - + #execute first workflow execute_options = %{ } @@ -216,7 +216,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do nil -> {:error, "Failed to create Workflow for request #{inspect workflow_request}"} workflow_request_id -> workflows = [workflow_request_id] - + if ref_component["type"] == "deployer" do workflow_request = %{ deployment_repo: "#{component["deployment_repo"]}_oa", diff --git a/lib/overseer/configuration.ex b/lib/overseer/configuration.ex index dfab626..dc650a7 100644 --- a/lib/overseer/configuration.ex +++ b/lib/overseer/configuration.ex @@ -7,13 +7,13 @@ defmodule OpenAperture.Overseer.Configuration do @doc """ Method to retrieve the currently assigned exchange id - + ## Options - + ## Return values The exchange identifier - """ + """ @spec get_current_exchange_id() :: String.t() def get_current_exchange_id do get_config("EXCHANGE_ID", :openaperture_overseer, :exchange_id) @@ -21,13 +21,13 @@ defmodule OpenAperture.Overseer.Configuration do @doc """ Method to retrieve the currently assigned exchange id - + ## Options - + ## Return values The exchange identifier - """ + """ @spec get_current_broker_id() :: String.t() def get_current_broker_id do get_config("BROKER_ID", :openaperture_overseer, :broker_id) @@ -35,13 +35,13 @@ defmodule OpenAperture.Overseer.Configuration do @doc """ Method to retrieve the currently assigned queue name (for "overseer") - + ## Options - + ## Return values The exchange identifier - """ + """ @spec get_current_queue_name() :: String.t() def get_current_queue_name do get_config("QUEUE_NAME", :openaperture_overseer, :queue_name) @@ -49,13 +49,13 @@ defmodule OpenAperture.Overseer.Configuration do @doc """ Method to retrieve the currently assigned queue name (for "system_modules") - + ## Options - + ## Return values The exchange identifier - """ + """ @spec get_current_system_modules_queue_name() :: String.t() def get_current_system_modules_queue_name do get_config("SYSTEM_MODULES_QUEUE_NAME", :openaperture_overseer, :system_modules_queue_name) @@ -63,21 +63,21 @@ defmodule OpenAperture.Overseer.Configuration do @doc false # Method to retrieve a configuration option from the environment or config settings - # + # ## Options - # + # # The `env_name` option defines the environment variable name # # The `application_config` option defines the config application name (atom) # # The `config_name` option defines the config variable name (atom) - # + # ## Return values - # + # # Value - # + # @spec get_config(String.t(), term, term) :: String.t() defp get_config(env_name, application_config, config_name) do System.get_env(env_name) || Application.get_env(application_config, config_name) - end + end end \ No newline at end of file diff --git a/lib/overseer/dispatcher.ex b/lib/overseer/dispatcher.ex index f4ddf72..33e3d59 100644 --- a/lib/overseer/dispatcher.ex +++ b/lib/overseer/dispatcher.ex @@ -24,8 +24,8 @@ defmodule OpenAperture.Overseer.Dispatcher do @logprefix "[Dispatcher]" @moduledoc """ - This module contains the logic to dispatch Overseer messsages to the appropriate GenServer(s) - """ + This module contains the logic to dispatch Overseer messsages to the appropriate GenServer(s) + """ @connection_options nil use OpenAperture.Messaging @@ -39,10 +39,10 @@ defmodule OpenAperture.Overseer.Dispatcher do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link do case GenServer.start_link(__MODULE__, %{}, name: __MODULE__) do - {:error, reason} -> + {:error, reason} -> Logger.error("#{@logprefix} Failed to start OpenAperture Overseer: #{inspect reason}") {:error, reason} {:ok, pid} -> @@ -50,10 +50,10 @@ defmodule OpenAperture.Overseer.Dispatcher do if Application.get_env(:autostart, :register_queues, true) do case register_queues do {:ok, _} -> {:ok, pid} - {:error, reason} -> + {:error, reason} -> Logger.error("#{@logprefix} Failed to register Overseer queues: #{inspect reason}") {:ok, pid} - end + end else {:ok, pid} end @@ -77,63 +77,63 @@ defmodule OpenAperture.Overseer.Dispatcher do overseer_queue = QueueBuilder.build(ManagerApi.get_api, Configuration.get_current_queue_name, Configuration.get_current_exchange_id) options = OpenAperture.Messaging.ConnectionOptionsResolver.get_for_broker(ManagerApi.get_api, Configuration.get_current_broker_id) - subscribe(options, overseer_queue, fn(payload, _meta, %{delivery_tag: delivery_tag} = async_info) -> + subscribe(options, overseer_queue, fn(payload, _meta, %{delivery_tag: delivery_tag} = async_info) -> MessageManager.track(async_info) request = Request.from_payload(payload) try do - process_request(request.action, request.options, delivery_tag) + process_request(request.action, request.options, delivery_tag) catch - :exit, code -> + :exit, code -> error_msg = "Message #{delivery_tag} (action #{request.action}) Exited with code #{inspect code}. Payload: #{inspect payload}" Logger.error(error_msg) event = %{ unique: true, - type: :unhandled_exception, - severity: :error, + type: :unhandled_exception, + severity: :error, data: %{ component: :overseer, exchange_id: Configuration.get_current_exchange_id, hostname: System.get_env("HOSTNAME") }, message: error_msg - } + } SystemEvent.create_system_event!(ManagerApi.get_api, event) acknowledge(delivery_tag) - :throw, value -> + :throw, value -> error_msg = "Message #{delivery_tag} (action #{request.action}) Throw called with #{inspect value}. Payload: #{inspect payload}" Logger.error(error_msg) event = %{ unique: true, - type: :unhandled_exception, - severity: :error, + type: :unhandled_exception, + severity: :error, data: %{ component: :overseer, exchange_id: Configuration.get_current_exchange_id, hostname: System.get_env("HOSTNAME") }, message: error_msg - } - SystemEvent.create_system_event!(ManagerApi.get_api, event) + } + SystemEvent.create_system_event!(ManagerApi.get_api, event) acknowledge(delivery_tag) - what, value -> + what, value -> error_msg = "Message #{delivery_tag} (action #{request.action}) Caught #{inspect what} with #{inspect value}. Payload: #{inspect payload}" Logger.error(error_msg) event = %{ unique: true, - type: :unhandled_exception, - severity: :error, + type: :unhandled_exception, + severity: :error, data: %{ component: :overseer, exchange_id: Configuration.get_current_exchange_id, hostname: System.get_env("HOSTNAME") }, message: error_msg - } - SystemEvent.create_system_event!(ManagerApi.get_api, event) + } + SystemEvent.create_system_event!(ManagerApi.get_api, event) acknowledge(delivery_tag) - end + end end) end @@ -203,5 +203,5 @@ defmodule OpenAperture.Overseer.Dispatcher do unless message == nil do SubscriptionHandler.reject(message[:subscription_handler], message[:delivery_tag], redeliver) end - end + end end \ No newline at end of file diff --git a/lib/overseer/message_manager.ex b/lib/overseer/message_manager.ex index 8a8f32b..e533bb6 100644 --- a/lib/overseer/message_manager.ex +++ b/lib/overseer/message_manager.ex @@ -12,7 +12,7 @@ defmodule OpenAperture.Overseer.MessageManager do @moduledoc """ This module contains the logic for associating message references with their subscription handlers - """ + """ @doc """ Creates a `GenServer` representing Docker host cluster. @@ -20,9 +20,9 @@ defmodule OpenAperture.Overseer.MessageManager do ## Return values {:ok, pid} | {:error, String.t()} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link() do - Logger.debug("#{@logprefix} Starting...") + Logger.debug("#{@logprefix} Starting...") Agent.start_link(fn -> %{} end, name: __MODULE__) end @@ -37,16 +37,16 @@ defmodule OpenAperture.Overseer.MessageManager do """ @spec track(Map) :: term def track(%{subscription_handler: subscription_handler, delivery_tag: delivery_tag} = _async_info) do - Logger.debug("#{@logprefix} Tracking message #{delivery_tag}...") + Logger.debug("#{@logprefix} Tracking message #{delivery_tag}...") new_message = %{ process: self(), - subscription_handler: subscription_handler, + subscription_handler: subscription_handler, delivery_tag: delivery_tag, start_time: :calendar.universal_time } Agent.update(__MODULE__, fn messages -> Map.put(messages, delivery_tag, new_message) end) - + new_message end diff --git a/lib/overseer/modules/listener.ex b/lib/overseer/modules/listener.ex index a2ef8e8..266837d 100644 --- a/lib/overseer/modules/listener.ex +++ b/lib/overseer/modules/listener.ex @@ -14,7 +14,7 @@ defmodule OpenAperture.Overseer.Modules.Listener do @moduledoc """ This module contains the logic to subscribe and unsubscribe from Module-specific queues - """ + """ @connection_options nil use OpenAperture.Messaging @@ -30,7 +30,7 @@ defmodule OpenAperture.Overseer.Modules.Listener do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link() do case GenServer.start_link(__MODULE__, %{}, []) do {:ok, listener} -> @@ -54,17 +54,17 @@ defmodule OpenAperture.Overseer.Modules.Listener do event_queue = QueueBuilder.build(ManagerApi.get_api, Configuration.get_current_system_modules_queue_name, Configuration.get_current_exchange_id) options = OpenAperture.Messaging.ConnectionOptionsResolver.get_for_broker(ManagerApi.get_api, Configuration.get_current_broker_id) - subscription_handler = case subscribe(options, event_queue, fn(payload, _meta, %{subscription_handler: subscription_handler, delivery_tag: delivery_tag} = _async_info) -> + subscription_handler = case subscribe(options, event_queue, fn(payload, _meta, %{subscription_handler: subscription_handler, delivery_tag: delivery_tag} = _async_info) -> #Logger.debug("[Listener] Received message #{delivery_tag}") #MessageManager.track(async_info) process_event(payload, delivery_tag) SubscriptionHandler.acknowledge(subscription_handler, delivery_tag) #MessageManager.remove(delivery_tag) end) do - {:ok, subscription_handler} -> + {:ok, subscription_handler} -> Logger.debug("[Listener] Successfully started event listener #{inspect subscription_handler}") subscription_handler - {:error, reason} -> + {:error, reason} -> Logger.error("[Listener] Failed to start event listener: #{inspect reason}") nil end @@ -93,14 +93,14 @@ defmodule OpenAperture.Overseer.Modules.Listener do } case MessagingExchangeModule.create_module!(Configuration.get_current_exchange_id, new_module) do - nil -> + nil -> response = MessagingExchangeModule.create_module(Configuration.get_current_exchange_id, new_module) if response.success? do Logger.debug("[Listener] Successfully updated module #{payload[:hostname]}") true else Logger.error("[Listener] Failed to update module #{payload[:hostname]}! module - #{inspect payload}, status - #{inspect response.status}, errors - #{inspect response.raw_body}") - false + false end _ -> Logger.debug("[Listener] Successfully updated module #{payload[:hostname]}") end diff --git a/lib/overseer/modules/manager.ex b/lib/overseer/modules/manager.ex index 06877f0..caa5d99 100644 --- a/lib/overseer/modules/manager.ex +++ b/lib/overseer/modules/manager.ex @@ -5,10 +5,10 @@ defmodule OpenAperture.Overseer.Modules.Manager do use Timex alias OpenAperture.ManagerApi.MessagingExchangeModule - + @moduledoc """ This module contains the GenServer for managing Module communication processes - """ + """ @doc """ Specific start_link implementation @@ -17,7 +17,7 @@ defmodule OpenAperture.Overseer.Modules.Manager do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link() do GenServer.start_link(__MODULE__, %{}, name: __MODULE__) end @@ -70,8 +70,8 @@ defmodule OpenAperture.Overseer.Modules.Manager do try do diff_seconds = get_last_updated_seconds(module) Logger.debug("[Manager] Reviewing module #{module["hostname"]} for activation status (last updated #{diff_seconds} seconds ago)...") - - cond do + + cond do module["status"] == "inactive" && diff_seconds > 600 -> Logger.debug("[Manager] Module #{module["hostname"]} has not been updated in at least 20 minutes, delete it") case MessagingExchangeModule.delete_module!(Application.get_env(:openaperture_overseer_api, :exchange_id), module["hostname"]) do @@ -89,9 +89,9 @@ defmodule OpenAperture.Overseer.Modules.Manager do end rescue e -> Logger.error("[Manager] An error occurred parsing updated_at time for a module: #{inspect e}") - end - end - end + end + end + end end defp get_last_updated_seconds(module) do @@ -101,11 +101,11 @@ defmodule OpenAperture.Overseer.Modules.Manager do else {:ok, updated_at} = DateFormat.parse(module["updated_at"], "{RFC1123}") updated_at_secs = Date.convert(updated_at, :secs) #since epoch - + now = Date.now #utc - now_secs = Date.convert(now, :secs) #since epoch + now_secs = Date.convert(now, :secs) #since epoch now_secs - updated_at_secs - end + end end end \ No newline at end of file diff --git a/lib/overseer/modules/retriever.ex b/lib/overseer/modules/retriever.ex index 5b3732f..a89e4c1 100644 --- a/lib/overseer/modules/retriever.ex +++ b/lib/overseer/modules/retriever.ex @@ -2,10 +2,10 @@ require Logger defmodule OpenAperture.Overseer.Modules.Retriever do use GenServer - + @moduledoc """ This module contains the GenServer for retrieving and caching MessagingExchangeModules - """ + """ alias OpenAperture.ManagerApi.MessagingExchangeModule alias OpenAperture.Overseer.Modules.Manager @@ -22,10 +22,10 @@ defmodule OpenAperture.Overseer.Modules.Retriever do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link() do case GenServer.start_link(__MODULE__, [], name: __MODULE__) do - {:ok, retriever} -> + {:ok, retriever} -> if Application.get_env(:autostart, :retrieve_modules, true) do GenServer.cast(retriever, {:retrieve_module_list}) end @@ -52,7 +52,7 @@ defmodule OpenAperture.Overseer.Modules.Retriever do Logger.debug("[Retriever] Sleeping for #{sleep_seconds} seconds before retrieving system modules...") :timer.sleep(sleep_seconds * 1000) GenServer.cast(__MODULE__, {:retrieve_module_list}) - + {:noreply, modules} end @@ -61,7 +61,7 @@ defmodule OpenAperture.Overseer.Modules.Retriever do Logger.debug("[Retriever] Retrieving system modules for exchange #{exchange_id}...") modules = case MessagingExchangeModule.list!(exchange_id) do - nil -> + nil -> Logger.error("[Retriever] Unable to load system modules from exchange #{exchange_id}!") nil modules -> modules diff --git a/lib/overseer/supervisor.ex b/lib/overseer/supervisor.ex index 6de823c..485ccfe 100644 --- a/lib/overseer/supervisor.ex +++ b/lib/overseer/supervisor.ex @@ -10,10 +10,10 @@ defmodule OpenAperture.Overseer.Supervisor do @moduledoc """ This module contains the supervisor for the dispatcher - """ - + """ + @doc """ - Specific start_link implementation + Specific start_link implementation ## Options @@ -21,7 +21,7 @@ defmodule OpenAperture.Overseer.Supervisor do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t()} def start_link do Logger.info("Starting OpenAperture.Overseer.Supervisor...") :supervisor.start_link(__MODULE__, []) @@ -37,7 +37,7 @@ defmodule OpenAperture.Overseer.Supervisor do ## Return Values {:ok, state} | {:ok, state, timeout} | :ignore | {:stop, reason} - """ + """ @spec init(term) :: {:ok, term} | {:ok, term, term} | :ignore | {:stop, String.t()} def init([]) do import Supervisor.Spec From 7fbd3195bcfb548724baf73d472f80ab8c8e62b2 Mon Sep 17 00:00:00 2001 From: "Kevin C. Baird" Date: Wed, 19 Aug 2015 13:17:38 -0400 Subject: [PATCH 2/5] String.t() -> String.t --- lib/overseer.ex | 2 +- lib/overseer/clusters/cluster_monitor.ex | 2 +- lib/overseer/clusters/clusters_monitor.ex | 2 +- lib/overseer/clusters/fleet_manager_publisher.ex | 10 +++++----- lib/overseer/components/component_mgr.ex | 2 +- lib/overseer/components/component_status_mgr.ex | 2 +- lib/overseer/components/components_mgr.ex | 2 +- lib/overseer/configuration.ex | 10 +++++----- lib/overseer/dispatcher.ex | 12 ++++++------ lib/overseer/message_manager.ex | 6 +++--- lib/overseer/modules/listener.ex | 6 +++--- lib/overseer/modules/manager.ex | 2 +- lib/overseer/modules/retriever.ex | 2 +- lib/overseer/supervisor.ex | 4 ++-- 14 files changed, 32 insertions(+), 32 deletions(-) diff --git a/lib/overseer.ex b/lib/overseer.ex index 0c56b18..0869f4e 100644 --- a/lib/overseer.ex +++ b/lib/overseer.ex @@ -44,7 +44,7 @@ defmodule OpenAperture.Overseer do Note also that the `:transient` type is of little practical use, since when a supervision tree terminates, the reason is set to `:shutdown`, not `:normal`. """ - @spec start(atom, [any]) :: :ok | {:error, String.t()} + @spec start(atom, [any]) :: :ok | {:error, String.t} def start(_type, _args) do import Supervisor.Spec, warn: false Logger.info("Starting OpenAperture.Overseer...") diff --git a/lib/overseer/clusters/cluster_monitor.ex b/lib/overseer/clusters/cluster_monitor.ex index 3ee7862..4eb331f 100644 --- a/lib/overseer/clusters/cluster_monitor.ex +++ b/lib/overseer/clusters/cluster_monitor.ex @@ -23,7 +23,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do {:ok, pid} | {:error, reason} """ - @spec start_link(Map) :: {:ok, pid} | {:error, String.t()} + @spec start_link(Map) :: {:ok, pid} | {:error, String.t} def start_link(cluster) do Logger.debug("#{@logprefix}[#{cluster["etcd_token"]}] Starting...") GenServer.start_link(__MODULE__, %{cluster: cluster, etcd_token: cluster["etcd_token"]}) diff --git a/lib/overseer/clusters/clusters_monitor.ex b/lib/overseer/clusters/clusters_monitor.ex index 34152b2..7467744 100644 --- a/lib/overseer/clusters/clusters_monitor.ex +++ b/lib/overseer/clusters/clusters_monitor.ex @@ -23,7 +23,7 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link() do Logger.debug("#{@logprefix} Starting...") case GenServer.start_link(__MODULE__, %{clusters: %{}}, name: __MODULE__) do diff --git a/lib/overseer/clusters/fleet_manager_publisher.ex b/lib/overseer/clusters/fleet_manager_publisher.ex index 3701cdd..dc2facb 100644 --- a/lib/overseer/clusters/fleet_manager_publisher.ex +++ b/lib/overseer/clusters/fleet_manager_publisher.ex @@ -25,7 +25,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do {:ok, pid} | {:error, reason} """ - @spec start_link :: {:ok, pid} | {:error, String.t()} + @spec start_link :: {:ok, pid} | {:error, String.t} def start_link do Logger.debug("Starting FleetManagerPublisher...") GenServer.start_link(__MODULE__, %{}, name: __MODULE__) @@ -44,7 +44,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do RpcHandler pid """ - @spec list_machines!(String.t(), term) :: pid + @spec list_machines!(String.t, term) :: pid def list_machines!(etcd_token, cluster_exchange_id) do request_body = %{ etcd_token: etcd_token, @@ -70,7 +70,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do RpcHandler pid """ - @spec list_units!(String.t(), term) :: pid + @spec list_units!(String.t, term) :: pid def list_units!(etcd_token, cluster_exchange_id) do request_body = %{ etcd_token: etcd_token, @@ -96,7 +96,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do RpcHandler pid """ - @spec list_unit_states!(String.t(), term) :: pid + @spec list_unit_states!(String.t, term) :: pid def list_unit_states!(etcd_token, cluster_exchange_id) do request_body = %{ etcd_token: etcd_token, @@ -124,7 +124,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do RpcHandler pid """ - @spec unit_logs!(String.t(), term, String.t) :: pid + @spec unit_logs!(String.t, term, String.t) :: pid def unit_logs!(etcd_token, cluster_exchange_id, unit_name) do request_body = %{ etcd_token: etcd_token, diff --git a/lib/overseer/components/component_mgr.ex b/lib/overseer/components/component_mgr.ex index 599138b..ad2e3fe 100644 --- a/lib/overseer/components/component_mgr.ex +++ b/lib/overseer/components/component_mgr.ex @@ -29,7 +29,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:ok, pid} | {:error, reason} """ - @spec start_link(Map) :: {:ok, pid} | {:error, String.t()} + @spec start_link(Map) :: {:ok, pid} | {:error, String.t} def start_link(component) do Logger.debug("#{@logprefix}[#{component["type"]}] Starting...") case GenServer.start_link(__MODULE__, %{component: component, updated_at: Time.now()}) do diff --git a/lib/overseer/components/component_status_mgr.ex b/lib/overseer/components/component_status_mgr.ex index 8a591cd..4b92cb8 100644 --- a/lib/overseer/components/component_status_mgr.ex +++ b/lib/overseer/components/component_status_mgr.ex @@ -21,7 +21,7 @@ defmodule OpenAperture.Overseer.Components.ComponentStatusMgr do {:ok, pid} | {:error, reason} """ - @spec start_link(pid) :: {:ok, pid} | {:error, String.t()} + @spec start_link(pid) :: {:ok, pid} | {:error, String.t} def start_link(mgr) do case GenServer.start_link(__MODULE__, %{component_mgr: mgr}) do {:error, reason} -> {:error, reason} diff --git a/lib/overseer/components/components_mgr.ex b/lib/overseer/components/components_mgr.ex index 709efe9..b3b310d 100644 --- a/lib/overseer/components/components_mgr.ex +++ b/lib/overseer/components/components_mgr.ex @@ -22,7 +22,7 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link() do Logger.debug("#{@logprefix} Starting...") diff --git a/lib/overseer/configuration.ex b/lib/overseer/configuration.ex index dc650a7..14813c8 100644 --- a/lib/overseer/configuration.ex +++ b/lib/overseer/configuration.ex @@ -14,7 +14,7 @@ defmodule OpenAperture.Overseer.Configuration do The exchange identifier """ - @spec get_current_exchange_id() :: String.t() + @spec get_current_exchange_id() :: String.t def get_current_exchange_id do get_config("EXCHANGE_ID", :openaperture_overseer, :exchange_id) end @@ -28,7 +28,7 @@ defmodule OpenAperture.Overseer.Configuration do The exchange identifier """ - @spec get_current_broker_id() :: String.t() + @spec get_current_broker_id() :: String.t def get_current_broker_id do get_config("BROKER_ID", :openaperture_overseer, :broker_id) end @@ -42,7 +42,7 @@ defmodule OpenAperture.Overseer.Configuration do The exchange identifier """ - @spec get_current_queue_name() :: String.t() + @spec get_current_queue_name() :: String.t def get_current_queue_name do get_config("QUEUE_NAME", :openaperture_overseer, :queue_name) end @@ -56,7 +56,7 @@ defmodule OpenAperture.Overseer.Configuration do The exchange identifier """ - @spec get_current_system_modules_queue_name() :: String.t() + @spec get_current_system_modules_queue_name() :: String.t def get_current_system_modules_queue_name do get_config("SYSTEM_MODULES_QUEUE_NAME", :openaperture_overseer, :system_modules_queue_name) end @@ -76,7 +76,7 @@ defmodule OpenAperture.Overseer.Configuration do # # Value # - @spec get_config(String.t(), term, term) :: String.t() + @spec get_config(String.t, term, term) :: String.t defp get_config(env_name, application_config, config_name) do System.get_env(env_name) || Application.get_env(application_config, config_name) end diff --git a/lib/overseer/dispatcher.ex b/lib/overseer/dispatcher.ex index 33e3d59..1b6c082 100644 --- a/lib/overseer/dispatcher.ex +++ b/lib/overseer/dispatcher.ex @@ -39,7 +39,7 @@ defmodule OpenAperture.Overseer.Dispatcher do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link do case GenServer.start_link(__MODULE__, %{}, name: __MODULE__) do {:error, reason} -> @@ -71,7 +71,7 @@ defmodule OpenAperture.Overseer.Dispatcher do :ok | {:error, reason} """ - @spec register_queues() :: :ok | {:error, String.t()} + @spec register_queues() :: :ok | {:error, String.t} def register_queues do Logger.debug("#{@logprefix} Registering #{Configuration.get_current_queue_name} queue...") overseer_queue = QueueBuilder.build(ManagerApi.get_api, Configuration.get_current_queue_name, Configuration.get_current_exchange_id) @@ -148,7 +148,7 @@ defmodule OpenAperture.Overseer.Dispatcher do The `delivery_tag` option is the unique identifier of the message """ - @spec process_request(:upgrade_request, Map, String.t()) :: term + @spec process_request(:upgrade_request, Map, String.t) :: term def process_request(:upgrade_request, options, delivery_tag) do Logger.debug("#{@logprefix} Processing an upgrade request for component #{options[:component_type]}...") mgr = ComponentsMgr.get_mgr_for_component_type(options[:component_type]) @@ -167,7 +167,7 @@ defmodule OpenAperture.Overseer.Dispatcher do The `delivery_tag` option is the unique identifier of the message """ - @spec process_request(term, Map, String.t()) :: term + @spec process_request(term, Map, String.t) :: term def process_request(unknown_action, _options, delivery_tag) do Logger.error("#{@logprefix} Unable to process request with action #{unknown_action}! This action is not currently supported") acknowledge(delivery_tag) @@ -180,7 +180,7 @@ defmodule OpenAperture.Overseer.Dispatcher do The `delivery_tag` option is the unique identifier of the message """ - @spec acknowledge(String.t()) :: term + @spec acknowledge(String.t) :: term def acknowledge(delivery_tag) do message = MessageManager.remove(delivery_tag) unless message == nil do @@ -197,7 +197,7 @@ defmodule OpenAperture.Overseer.Dispatcher do The `redeliver` option can be used to requeue a message """ - @spec reject(String.t(), term) :: term + @spec reject(String.t, term) :: term def reject(delivery_tag, redeliver \\ false) do message = MessageManager.remove(delivery_tag) unless message == nil do diff --git a/lib/overseer/message_manager.ex b/lib/overseer/message_manager.ex index e533bb6..0c07dde 100644 --- a/lib/overseer/message_manager.ex +++ b/lib/overseer/message_manager.ex @@ -18,9 +18,9 @@ defmodule OpenAperture.Overseer.MessageManager do Creates a `GenServer` representing Docker host cluster. ## Return values - {:ok, pid} | {:error, String.t()} + {:ok, pid} | {:error, String.t} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link() do Logger.debug("#{@logprefix} Starting...") Agent.start_link(fn -> %{} end, name: __MODULE__) @@ -61,7 +61,7 @@ defmodule OpenAperture.Overseer.MessageManager do Map containing the subscription_handler and delivery_tag """ - @spec remove(String.t()) :: Map + @spec remove(String.t) :: Map def remove(delivery_tag) do Logger.debug("#{@logprefix} Finished tracking message #{delivery_tag}...") diff --git a/lib/overseer/modules/listener.ex b/lib/overseer/modules/listener.ex index 266837d..d396682 100644 --- a/lib/overseer/modules/listener.ex +++ b/lib/overseer/modules/listener.ex @@ -30,7 +30,7 @@ defmodule OpenAperture.Overseer.Modules.Listener do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link() do case GenServer.start_link(__MODULE__, %{}, []) do {:ok, listener} -> @@ -81,7 +81,7 @@ defmodule OpenAperture.Overseer.Modules.Listener do The `delivery_tag` option is the unique identifier of the message """ - @spec process_event(Map, String.t()) :: term + @spec process_event(Map, String.t) :: term def process_event(%{event_type: :status} = payload, _delivery_tag) do Logger.debug("Received a status event from module #{payload[:hostname]}") @@ -115,7 +115,7 @@ defmodule OpenAperture.Overseer.Modules.Listener do The `delivery_tag` option is the unique identifier of the message """ - @spec process_event(Map, String.t()) :: term + @spec process_event(Map, String.t) :: term def process_event(%{event_type: type} = _payload, _delivery_tag) do Logger.debug("[Listener] Received an unknown event: #{inspect type}") end diff --git a/lib/overseer/modules/manager.ex b/lib/overseer/modules/manager.ex index caa5d99..c3696cd 100644 --- a/lib/overseer/modules/manager.ex +++ b/lib/overseer/modules/manager.ex @@ -17,7 +17,7 @@ defmodule OpenAperture.Overseer.Modules.Manager do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link() do GenServer.start_link(__MODULE__, %{}, name: __MODULE__) end diff --git a/lib/overseer/modules/retriever.ex b/lib/overseer/modules/retriever.ex index a89e4c1..7298030 100644 --- a/lib/overseer/modules/retriever.ex +++ b/lib/overseer/modules/retriever.ex @@ -22,7 +22,7 @@ defmodule OpenAperture.Overseer.Modules.Retriever do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link() do case GenServer.start_link(__MODULE__, [], name: __MODULE__) do {:ok, retriever} -> diff --git a/lib/overseer/supervisor.ex b/lib/overseer/supervisor.ex index 485ccfe..04a9b3d 100644 --- a/lib/overseer/supervisor.ex +++ b/lib/overseer/supervisor.ex @@ -21,7 +21,7 @@ defmodule OpenAperture.Overseer.Supervisor do {:ok, pid} | {:error, reason} """ - @spec start_link() :: {:ok, pid} | {:error, String.t()} + @spec start_link() :: {:ok, pid} | {:error, String.t} def start_link do Logger.info("Starting OpenAperture.Overseer.Supervisor...") :supervisor.start_link(__MODULE__, []) @@ -38,7 +38,7 @@ defmodule OpenAperture.Overseer.Supervisor do {:ok, state} | {:ok, state, timeout} | :ignore | {:stop, reason} """ - @spec init(term) :: {:ok, term} | {:ok, term, term} | :ignore | {:stop, String.t()} + @spec init(term) :: {:ok, term} | {:ok, term, term} | :ignore | {:stop, String.t} def init([]) do import Supervisor.Spec From 8e90105aed2ac16f621021555038ec868d8e89ea Mon Sep 17 00:00:00 2001 From: "Kevin C. Baird" Date: Wed, 19 Aug 2015 13:19:58 -0400 Subject: [PATCH 3/5] Map -> map in type specs --- lib/overseer/dispatcher.ex | 6 +++--- lib/overseer/message_manager.ex | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/overseer/dispatcher.ex b/lib/overseer/dispatcher.ex index 1b6c082..1c3da52 100644 --- a/lib/overseer/dispatcher.ex +++ b/lib/overseer/dispatcher.ex @@ -148,7 +148,7 @@ defmodule OpenAperture.Overseer.Dispatcher do The `delivery_tag` option is the unique identifier of the message """ - @spec process_request(:upgrade_request, Map, String.t) :: term + @spec process_request(:upgrade_request, map, String.t) :: term def process_request(:upgrade_request, options, delivery_tag) do Logger.debug("#{@logprefix} Processing an upgrade request for component #{options[:component_type]}...") mgr = ComponentsMgr.get_mgr_for_component_type(options[:component_type]) @@ -167,7 +167,7 @@ defmodule OpenAperture.Overseer.Dispatcher do The `delivery_tag` option is the unique identifier of the message """ - @spec process_request(term, Map, String.t) :: term + @spec process_request(term, map, String.t) :: term def process_request(unknown_action, _options, delivery_tag) do Logger.error("#{@logprefix} Unable to process request with action #{unknown_action}! This action is not currently supported") acknowledge(delivery_tag) @@ -204,4 +204,4 @@ defmodule OpenAperture.Overseer.Dispatcher do SubscriptionHandler.reject(message[:subscription_handler], message[:delivery_tag], redeliver) end end -end \ No newline at end of file +end diff --git a/lib/overseer/message_manager.ex b/lib/overseer/message_manager.ex index 0c07dde..781a3aa 100644 --- a/lib/overseer/message_manager.ex +++ b/lib/overseer/message_manager.ex @@ -35,7 +35,7 @@ defmodule OpenAperture.Overseer.MessageManager do * :subscription_handler * :delivery_tag """ - @spec track(Map) :: term + @spec track(map) :: term def track(%{subscription_handler: subscription_handler, delivery_tag: delivery_tag} = _async_info) do Logger.debug("#{@logprefix} Tracking message #{delivery_tag}...") new_message = %{ @@ -61,7 +61,7 @@ defmodule OpenAperture.Overseer.MessageManager do Map containing the subscription_handler and delivery_tag """ - @spec remove(String.t) :: Map + @spec remove(String.t) :: map def remove(delivery_tag) do Logger.debug("#{@logprefix} Finished tracking message #{delivery_tag}...") @@ -70,4 +70,4 @@ defmodule OpenAperture.Overseer.MessageManager do {message, Map.delete(messages, delivery_tag)} end) end -end \ No newline at end of file +end From 4f78800e35f30d8e1978fcacf361e4907c65185b Mon Sep 17 00:00:00 2001 From: "Kevin C. Baird" Date: Wed, 19 Aug 2015 13:31:41 -0400 Subject: [PATCH 4/5] Downcase a whole mess o' types in specs --- lib/overseer/clusters/cluster_monitor.ex | 16 ++++----- lib/overseer/clusters/clusters_monitor.ex | 12 +++---- .../clusters/fleet_manager_publisher.ex | 6 ++-- lib/overseer/components/component_mgr.ex | 34 +++++++++---------- .../components/component_status_mgr.ex | 4 +-- lib/overseer/components/components_mgr.ex | 6 ++-- lib/overseer/components/monitor_task.ex | 8 ++--- lib/overseer/components/upgrade_task.ex | 10 +++--- lib/overseer/modules/listener.ex | 8 ++--- lib/overseer/modules/manager.ex | 8 ++--- lib/overseer/modules/retriever.ex | 4 +-- 11 files changed, 58 insertions(+), 58 deletions(-) diff --git a/lib/overseer/clusters/cluster_monitor.ex b/lib/overseer/clusters/cluster_monitor.ex index 4eb331f..65d7dd1 100644 --- a/lib/overseer/clusters/cluster_monitor.ex +++ b/lib/overseer/clusters/cluster_monitor.ex @@ -23,7 +23,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do {:ok, pid} | {:error, reason} """ - @spec start_link(Map) :: {:ok, pid} | {:error, String.t} + @spec start_link(map) :: {:ok, pid} | {:error, String.t} def start_link(cluster) do Logger.debug("#{@logprefix}[#{cluster["etcd_token"]}] Starting...") GenServer.start_link(__MODULE__, %{cluster: cluster, etcd_token: cluster["etcd_token"]}) @@ -56,7 +56,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do {:noreply, state} """ - @spec handle_cast({:monitor}, Map) :: {:noreply, Map} + @spec handle_cast({:monitor}, map) :: {:noreply, map} def handle_cast({:monitor}, state) do monitor_cluster(state[:etcd_token]) monitor_cluster_units(state[:etcd_token]) @@ -115,7 +115,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do The `hosts` option defines the list of hosts in the cluster """ - @spec monitor_hosts(String.t, List) :: term + @spec monitor_hosts(String.t, list) :: term def monitor_hosts(etcd_token, hosts) do hostnames = Enum.reduce hosts, [], fn(host, hostnames) -> hostnames ++ [host["primaryIP"]] @@ -137,7 +137,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do The `node_info` option defines the Map of all host information """ - @spec monitor_host([], Map, String.t) :: term + @spec monitor_host([], map, String.t) :: term def monitor_host([], _node_info, _etcd_token) do Logger.debug("Finished reviewing node_info") end @@ -152,7 +152,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do The `node_info` option defines the Map of all host information """ - @spec monitor_host(List, Map, String.t) :: term + @spec monitor_host(list, map, String.t) :: term def monitor_host([returned_hostname | remaining_hostnames], node_info, etcd_token) do info = node_info[returned_hostname] @@ -264,7 +264,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do The `etcd_token` option defines the EtcdToken associated with the cluster """ - @spec monitor_unit_instances(List, String.t, term) :: term + @spec monitor_unit_instances(list, String.t, term) :: term def monitor_unit_instances([unit| remaining_units] = all_units, etcd_token, failure_count) do event = cond do #give failed units 3 tries before generating an error @@ -305,7 +305,7 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do The `etcd_token` option defines the EtcdToken associated with the cluster """ - @spec monitor_units(List, String.t) :: term + @spec monitor_units(list, String.t) :: term def monitor_units(units, etcd_token) do if units == nil || length(units) == 0 do Logger.debug("#{@logprefix} There are no units in cluster #{etcd_token} to review") @@ -343,4 +343,4 @@ defmodule OpenAperture.Overseer.Clusters.ClusterMonitor do end end end -end \ No newline at end of file +end diff --git a/lib/overseer/clusters/clusters_monitor.ex b/lib/overseer/clusters/clusters_monitor.ex index 7467744..9595a77 100644 --- a/lib/overseer/clusters/clusters_monitor.ex +++ b/lib/overseer/clusters/clusters_monitor.ex @@ -47,7 +47,7 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do {:noreply, state} """ - @spec handle_cast({:monitor}, Map) :: {:noreply, Map} + @spec handle_cast({:monitor}, map) :: {:noreply, map} def handle_cast({:monitor}, state) do #sleep for up to half an hour sleep_seconds = :random.uniform(1800) @@ -72,7 +72,7 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do The `state` option is the GenServer's state """ - @spec monitor_cached_clusters(Map) :: Map + @spec monitor_cached_clusters(map) :: map def monitor_cached_clusters(state) do Enum.reduce Map.values(state[:clusters]), nil, fn monitor, _result -> ClusterMonitor.monitor(monitor) @@ -90,7 +90,7 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do state """ - @spec monitor_clusters(Map) :: Map + @spec monitor_clusters(map) :: map def monitor_clusters(state) do exchange_id = Configuration.get_current_exchange_id @@ -122,7 +122,7 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do state """ - @spec monitor_cluster(Map, Map) :: Map + @spec monitor_cluster(map, map) :: map def monitor_cluster(state, cluster) do if state[:clusters][cluster["etcd_token"]] == nil do case ClusterMonitor.start_link(cluster) do @@ -154,7 +154,7 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do state """ - @spec stop_monitoring_clusters(Map, List) :: Map + @spec stop_monitoring_clusters(map, list) :: map def stop_monitoring_clusters(state, clusters \\ nil) do if clusters == nil do clusters = Map.keys(state[:clusters]) @@ -176,4 +176,4 @@ defmodule OpenAperture.Overseer.Clusters.ClustersMonitor do state end end -end \ No newline at end of file +end diff --git a/lib/overseer/clusters/fleet_manager_publisher.ex b/lib/overseer/clusters/fleet_manager_publisher.ex index dc2facb..5a6037b 100644 --- a/lib/overseer/clusters/fleet_manager_publisher.ex +++ b/lib/overseer/clusters/fleet_manager_publisher.ex @@ -153,7 +153,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do RpcHandler pid """ - @spec node_info!(term, List) :: pid + @spec node_info!(term, list) :: pid def node_info!(cluster_exchange_id, nodes) do request_body = %{ action: :node_info, @@ -168,7 +168,7 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do end end - @spec handle_call({:execute_rpc_request, Map, term}, term, Map) :: {:reply, pid, Map} + @spec handle_call({:execute_rpc_request, map, term}, term, map) :: {:reply, pid, map} def handle_call({:execute_rpc_request, request_body, cluster_exchange_id}, _from, state) do request = %RpcRequest{ status: :not_started, @@ -186,4 +186,4 @@ defmodule OpenAperture.Overseer.FleetManagerPublisher do {:reply, publish_rpc(connection_options, fleet_manager_queue, ManagerApi.get_api, request), state} end -end \ No newline at end of file +end diff --git a/lib/overseer/components/component_mgr.ex b/lib/overseer/components/component_mgr.ex index ad2e3fe..8ab82f5 100644 --- a/lib/overseer/components/component_mgr.ex +++ b/lib/overseer/components/component_mgr.ex @@ -29,7 +29,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:ok, pid} | {:error, reason} """ - @spec start_link(Map) :: {:ok, pid} | {:error, String.t} + @spec start_link(map) :: {:ok, pid} | {:error, String.t} def start_link(component) do Logger.debug("#{@logprefix}[#{component["type"]}] Starting...") case GenServer.start_link(__MODULE__, %{component: component, updated_at: Time.now()}) do @@ -62,7 +62,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do Map containing the refreshed component """ - @spec refresh(pid) :: Map + @spec refresh(pid) :: map def refresh(mgr) do GenServer.call(mgr, {:refresh_component}) end @@ -78,7 +78,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do Map containing the cached component """ - @spec component(pid) :: Map + @spec component(pid) :: map def component(mgr) do GenServer.call(mgr, {:get_component}) end @@ -96,7 +96,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do Map containing the updated component """ - @spec save(pid, Map) :: Map + @spec save(pid, map) :: map def save(mgr, updated_component) do GenServer.call(mgr, {:save, updated_component}) end @@ -112,7 +112,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do the upgrade / monitoring async Task """ - @spec request_upgrade(pid) :: Task + @spec request_upgrade(pid) :: task def request_upgrade(mgr) do GenServer.call(mgr, {:request_upgrade}) end @@ -128,7 +128,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do the upgrade / monitoring async Task """ - @spec current_upgrade_task(pid) :: Task + @spec current_upgrade_task(pid) :: task def current_upgrade_task(mgr) do GenServer.call(mgr, {:current_upgrade_task}) end @@ -144,7 +144,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do the upgrade / monitoring async Task """ - @spec set_task(pid, term, Task) :: Task + @spec set_task(pid, term, task) :: task def set_task(mgr, task_type, task) do GenServer.call(mgr, {:set_upgrade_task, task_type, task}) end @@ -162,7 +162,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, component, state} """ - @spec handle_call({:get_component}, pid, Map) :: {:reply, Map, Map} + @spec handle_call({:get_component}, pid, map) :: {:reply, map, map} def handle_call({:get_component}, _from, state) do {:reply, state[:component], state} end @@ -182,7 +182,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, updated_component or original if save fails, state} """ - @spec handle_call({:save, Map}, pid, Map) :: {:reply, Map, Map} + @spec handle_call({:save, map}, pid, map) :: {:reply, map, map} def handle_call({:save, updated_component}, _from, state) do response = SystemComponent.update_system_component(ManagerApi.get_api, updated_component["id"], updated_component) if response.success? do @@ -209,7 +209,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, updated component, state} """ - @spec handle_call({:refresh_component}, pid, Map) :: {:reply, Map, Map} + @spec handle_call({:refresh_component}, pid, map) :: {:reply, map, map} def handle_call({:refresh_component}, _from, state) do case SystemComponent.get_system_component!(ManagerApi.get_api, state[:component]["id"]) do nil -> @@ -234,9 +234,9 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do ## Return Values - {:reply, Task, state} + {:reply, task, state} """ - @spec handle_call({:request_upgrade}, pid, Map) :: {:reply, Task, Map} + @spec handle_call({:request_upgrade}, pid, map) :: {:reply, task, map} def handle_call({:request_upgrade}, _from, state) do if state[:upgrade_task] != nil && !Process.alive?(state[:upgrade_task].pid) do @@ -275,9 +275,9 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do ## Return Values - {:reply, Task, state} + {:reply, task, state} """ - @spec handle_call({:current_upgrade_task}, pid, Map) :: {:reply, Task, Map} + @spec handle_call({:current_upgrade_task}, pid, map) :: {:reply, task, map} def handle_call({:current_upgrade_task}, _from, state) do task = cond do state[:monitoring_task] != nil -> state[:monitoring_task] @@ -303,7 +303,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, manager, state} """ - @spec handle_call({:set_status_mgr, pid}, pid, Map) :: {:reply, pid, Map} + @spec handle_call({:set_status_mgr, pid}, pid, map) :: {:reply, pid, map} def handle_call({:set_status_mgr, mgr}, _from, state) do state = Map.put(state, :status_mgr, mgr) {:reply, mgr, state} @@ -326,9 +326,9 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, manager, state} """ - @spec handle_call({:set_upgrade_task, term, Task}, pid, Map) :: {:reply, Task, Map} + @spec handle_call({:set_upgrade_task, term, task}, pid, map) :: {:reply, task, map} def handle_call({:set_upgrade_task, task_type, task}, _from, state) do state = Map.put(state, task_type, task) {:reply, task, state} end -end \ No newline at end of file +end diff --git a/lib/overseer/components/component_status_mgr.ex b/lib/overseer/components/component_status_mgr.ex index 4b92cb8..ba8ff85 100644 --- a/lib/overseer/components/component_status_mgr.ex +++ b/lib/overseer/components/component_status_mgr.ex @@ -42,7 +42,7 @@ defmodule OpenAperture.Overseer.Components.ComponentStatusMgr do {:noreply, state} """ - @spec handle_cast({:check_for_upgrade}, Map) :: {:noreply, Map} + @spec handle_cast({:check_for_upgrade}, map) :: {:noreply, map} def handle_cast({:check_for_upgrade}, state) do check_for_upgrade(state) @@ -61,7 +61,7 @@ defmodule OpenAperture.Overseer.Components.ComponentStatusMgr do state """ - @spec check_for_upgrade(Map) :: Map + @spec check_for_upgrade(map) :: map def check_for_upgrade(state) do component = ComponentMgr.component(state[:component_mgr]) upgrade_strategy = if component["upgrade_strategy"] != nil, do: String.to_atom(component["upgrade_strategy"]) diff --git a/lib/overseer/components/components_mgr.ex b/lib/overseer/components/components_mgr.ex index b3b310d..14303eb 100644 --- a/lib/overseer/components/components_mgr.ex +++ b/lib/overseer/components/components_mgr.ex @@ -63,7 +63,7 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do {:noreply, state} """ - @spec handle_cast({:resolve_system_components}, Map) :: {:noreply, Map} + @spec handle_cast({:resolve_system_components}, map) :: {:noreply, map} def handle_cast({:resolve_system_components}, state) do state = resolve_system_components(state) :timer.sleep(300000) @@ -83,7 +83,7 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do Map, containing the updated state """ - @spec resolve_system_components(Map) :: Map + @spec resolve_system_components(map) :: map def resolve_system_components(state) do exchange_id = Configuration.get_current_exchange_id @@ -127,4 +127,4 @@ defmodule OpenAperture.Overseer.Components.ComponentsMgr do updated_state end -end \ No newline at end of file +end diff --git a/lib/overseer/components/monitor_task.ex b/lib/overseer/components/monitor_task.ex index b7ef21f..75b4a7a 100644 --- a/lib/overseer/components/monitor_task.ex +++ b/lib/overseer/components/monitor_task.ex @@ -25,7 +25,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do Task """ - @spec create(pid) :: Task + @spec create(pid) :: task def create(mgr) do Task.async(fn -> try do @@ -118,7 +118,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do {:ok, updated_status} | {:error, reason} """ - @spec check_upgrade_status(pid, Map) :: {:ok, term} | {:error, term} + @spec check_upgrade_status(pid, map) :: {:ok, term} | {:error, term} def check_upgrade_status(mgr, component) do current_workflow = resolve_current_workflow(component["upgrade_status"]) @@ -170,7 +170,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do Map of the last Upgrade """ - @spec resolve_current_workflow(Map) :: Map + @spec resolve_current_workflow(map) :: map def resolve_current_workflow(upgrade_status) do if upgrade_status == nil || upgrade_status["workflows"] == nil || length(upgrade_status["workflows"]) == 0 do nil @@ -193,4 +193,4 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do end end end -end \ No newline at end of file +end diff --git a/lib/overseer/components/upgrade_task.ex b/lib/overseer/components/upgrade_task.ex index 8f89df6..f238759 100644 --- a/lib/overseer/components/upgrade_task.ex +++ b/lib/overseer/components/upgrade_task.ex @@ -27,7 +27,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do Task """ - @spec create(pid) :: Task + @spec create(pid) :: task def create(mgr) do Task.async(fn -> try do @@ -102,7 +102,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do {true, SystemComponentRef} | {false, reason, SystemComponentRef} """ - @spec eligible_for_upgrade?(Map) :: {true, Map} | {false, term, Map} + @spec eligible_for_upgrade?(map) :: {true, map} | {false, term, map} def eligible_for_upgrade?(component) do type = component["type"] case SystemComponentRef.get_system_component_ref!(ManagerApi.get_api, type) do @@ -146,7 +146,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do :ok | {:error, reason} """ - @spec upgrade(pid, Map, Map) :: :ok | {:error, term} + @spec upgrade(pid, map, map) :: :ok | {:error, term} def upgrade(mgr, component, ref_component) do Logger.debug("#{@logprefix}[#{component["type"]}] Component #{component["type"]} is eligible for upgrade, executing an upgrade request...") @@ -202,7 +202,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do {:ok, Workflows} | {:error, reason} """ - @spec create_upgrade_workflows(Map, Map) :: {:ok, List} | {:error, term} + @spec create_upgrade_workflows(map, map) :: {:ok, list} | {:error, term} def create_upgrade_workflows(component, ref_component) do workflow_request = %{ deployment_repo: component["deployment_repo"], @@ -235,4 +235,4 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do end end end -end \ No newline at end of file +end diff --git a/lib/overseer/modules/listener.ex b/lib/overseer/modules/listener.ex index d396682..6d3439e 100644 --- a/lib/overseer/modules/listener.ex +++ b/lib/overseer/modules/listener.ex @@ -48,7 +48,7 @@ defmodule OpenAperture.Overseer.Modules.Listener do {:noreply, state} """ - @spec handle_cast({:start_listening}, Map) :: {:noreply, Map} + @spec handle_cast({:start_listening}, map) :: {:noreply, map} def handle_cast({:start_listening}, state) do Logger.debug("[Listener] Starting event listener...") event_queue = QueueBuilder.build(ManagerApi.get_api, Configuration.get_current_system_modules_queue_name, Configuration.get_current_exchange_id) @@ -81,7 +81,7 @@ defmodule OpenAperture.Overseer.Modules.Listener do The `delivery_tag` option is the unique identifier of the message """ - @spec process_event(Map, String.t) :: term + @spec process_event(map, String.t) :: term def process_event(%{event_type: :status} = payload, _delivery_tag) do Logger.debug("Received a status event from module #{payload[:hostname]}") @@ -115,8 +115,8 @@ defmodule OpenAperture.Overseer.Modules.Listener do The `delivery_tag` option is the unique identifier of the message """ - @spec process_event(Map, String.t) :: term + @spec process_event(map, String.t) :: term def process_event(%{event_type: type} = _payload, _delivery_tag) do Logger.debug("[Listener] Received an unknown event: #{inspect type}") end -end \ No newline at end of file +end diff --git a/lib/overseer/modules/manager.ex b/lib/overseer/modules/manager.ex index c3696cd..abcd003 100644 --- a/lib/overseer/modules/manager.ex +++ b/lib/overseer/modules/manager.ex @@ -33,7 +33,7 @@ defmodule OpenAperture.Overseer.Modules.Manager do :ok """ - @spec set_modules(List) :: :ok + @spec set_modules(list) :: :ok def set_modules(modules) do GenServer.cast(__MODULE__, {:set_modules, modules}) end @@ -44,7 +44,7 @@ defmodule OpenAperture.Overseer.Modules.Manager do {:noreply, state} """ - @spec handle_cast(pid, term) :: {:noreply, Map} + @spec handle_cast(pid, term) :: {:noreply, map} def handle_cast({:set_modules, modules}, state) do inactivate_listeners(modules) {:noreply, state} @@ -60,7 +60,7 @@ defmodule OpenAperture.Overseer.Modules.Manager do The `modules` option is the list of modules """ - @spec inactivate_listeners(Map) :: term + @spec inactivate_listeners(map) :: term def inactivate_listeners(modules) do if modules == nil || length(modules) == 0 do Logger.debug("[Manager] There are no modules to review for inactivation") @@ -108,4 +108,4 @@ defmodule OpenAperture.Overseer.Modules.Manager do now_secs - updated_at_secs end end -end \ No newline at end of file +end diff --git a/lib/overseer/modules/retriever.ex b/lib/overseer/modules/retriever.ex index 7298030..1a41cdb 100644 --- a/lib/overseer/modules/retriever.ex +++ b/lib/overseer/modules/retriever.ex @@ -41,7 +41,7 @@ defmodule OpenAperture.Overseer.Modules.Retriever do {:noreply, new modules list} """ - @spec handle_cast({:retrieve_module_list}, term) :: {:noreply, List} + @spec handle_cast({:retrieve_module_list}, term) :: {:noreply, list} def handle_cast({:retrieve_module_list}, _state) do modules = refresh_modules @@ -70,4 +70,4 @@ defmodule OpenAperture.Overseer.Modules.Retriever do modules end -end \ No newline at end of file +end From 9e5f8caf34e18994df1f94600aeaae36e0636178 Mon Sep 17 00:00:00 2001 From: "Kevin C. Baird" Date: Wed, 19 Aug 2015 13:39:23 -0400 Subject: [PATCH 5/5] task -> Task.t in type specs --- lib/overseer/components/component_mgr.ex | 14 +++++++------- lib/overseer/components/monitor_task.ex | 2 +- lib/overseer/components/upgrade_task.ex | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/overseer/components/component_mgr.ex b/lib/overseer/components/component_mgr.ex index 8ab82f5..b4bf84a 100644 --- a/lib/overseer/components/component_mgr.ex +++ b/lib/overseer/components/component_mgr.ex @@ -112,7 +112,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do the upgrade / monitoring async Task """ - @spec request_upgrade(pid) :: task + @spec request_upgrade(pid) :: Task.t def request_upgrade(mgr) do GenServer.call(mgr, {:request_upgrade}) end @@ -128,7 +128,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do the upgrade / monitoring async Task """ - @spec current_upgrade_task(pid) :: task + @spec current_upgrade_task(pid) :: Task.t def current_upgrade_task(mgr) do GenServer.call(mgr, {:current_upgrade_task}) end @@ -144,7 +144,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do the upgrade / monitoring async Task """ - @spec set_task(pid, term, task) :: task + @spec set_task(pid, term, Task.t) :: Task.t def set_task(mgr, task_type, task) do GenServer.call(mgr, {:set_upgrade_task, task_type, task}) end @@ -234,9 +234,9 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do ## Return Values - {:reply, task, state} + {:reply, Task, state} """ - @spec handle_call({:request_upgrade}, pid, map) :: {:reply, task, map} + @spec handle_call({:request_upgrade}, pid, map) :: {:reply, Task.t, map} def handle_call({:request_upgrade}, _from, state) do if state[:upgrade_task] != nil && !Process.alive?(state[:upgrade_task].pid) do @@ -277,7 +277,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, task, state} """ - @spec handle_call({:current_upgrade_task}, pid, map) :: {:reply, task, map} + @spec handle_call({:current_upgrade_task}, pid, map) :: {:reply, Task.t, map} def handle_call({:current_upgrade_task}, _from, state) do task = cond do state[:monitoring_task] != nil -> state[:monitoring_task] @@ -326,7 +326,7 @@ defmodule OpenAperture.Overseer.Components.ComponentMgr do {:reply, manager, state} """ - @spec handle_call({:set_upgrade_task, term, task}, pid, map) :: {:reply, task, map} + @spec handle_call({:set_upgrade_task, term, Task.t}, pid, map) :: {:reply, Task.t, map} def handle_call({:set_upgrade_task, task_type, task}, _from, state) do state = Map.put(state, task_type, task) {:reply, task, state} diff --git a/lib/overseer/components/monitor_task.ex b/lib/overseer/components/monitor_task.ex index 75b4a7a..081ade5 100644 --- a/lib/overseer/components/monitor_task.ex +++ b/lib/overseer/components/monitor_task.ex @@ -25,7 +25,7 @@ defmodule OpenAperture.Overseer.Components.MonitorTask do Task """ - @spec create(pid) :: task + @spec create(pid) :: Task.t def create(mgr) do Task.async(fn -> try do diff --git a/lib/overseer/components/upgrade_task.ex b/lib/overseer/components/upgrade_task.ex index f238759..3a05e4f 100644 --- a/lib/overseer/components/upgrade_task.ex +++ b/lib/overseer/components/upgrade_task.ex @@ -27,7 +27,7 @@ defmodule OpenAperture.Overseer.Components.UpgradeTask do Task """ - @spec create(pid) :: task + @spec create(pid) :: Task.t def create(mgr) do Task.async(fn -> try do