derive speeds from ntd technology and avc bandwidth_profile

Author: matt-beanland

lib/access/util.ex

@@ -18,8 +18,6 @@ defmodule DiffoExample.Access.Util do
   """
   def assignments(instance, type) when is_struct(instance, Ash.Resource) and is_atom(type) do
     Enum.reduce(instance.reverse_relationships, [], fn reverse_relationship, acc ->
-      IO.inspect(reverse_relationship, label: :reverse_relationship)
-
       case reverse_relationship.type do
         :assignedTo ->
           characteristic =

lib/nbn/nbn.ex

@@ -41,19 +41,22 @@ defmodule DiffoExample.Nbn do
       define :build_uni, action: :build
       define :define_uni, action: :define
       define :relate_uni, action: :relate
+      define :mine_uni, action: :mine
     end
 
     resource Avc do
       define :get_avc_by_id, action: :read, get_by: :id
       define :build_avc, action: :build
       define :define_avc, action: :define
       define :relate_avc, action: :relate
+      define :mine_avc, action: :mine
     end
 
     resource Ntd do
       define :get_ntd_by_id, action: :read, get_by: :id
       define :build_ntd, action: :build
       define :define_ntd, action: :define
+      define :assign_port, action: :assign_port
       define :relate_ntd, action: :relate
     end
 
@@ -63,6 +66,7 @@ defmodule DiffoExample.Nbn do
       define :define_cvc, action: :define
       define :assign_cvlan, action: :assign_cvlan
       define :relate_cvc, action: :relate
+      define :mine_cvc, action: :mine
     end
 
     resource NniGroup do

lib/nbn/resources/avc.ex

@@ -38,6 +38,7 @@ defmodule DiffoExample.Nbn.Avc do
 
   characteristics do
     characteristic :avc, DiffoExample.Nbn.AvcValue
+    characteristic :cvc, DiffoExample.Nbn.CvcValue
   end
 
   actions do
@@ -86,9 +87,33 @@ defmodule DiffoExample.Nbn.Avc do
                     do: {:ok, result}
              end)
     end
+
+    update :mine do
+      description "updates the AVC with data mined from related instances"
+      argument :characteristic_value_updates, {:array, :term}
+
+      change before_action(fn changeset, context ->
+               DiffoExample.Nbn.Avc.mine_related(changeset, context)
+             end)
+
+      change after_action(fn changeset, result, _context ->
+               with {:ok, result} <- Characteristic.update_values(result, changeset),
+                    {:ok, result} <- Nbn.get_avc_by_id(result.id),
+                    do: {:ok, result}
+             end)
+    end
   end
 
   def identifier() do
     DiffoExample.Nbn.Util.identifier("AVC")
   end
+
+  # mines related resource to characteristics
+  def mine_related(changeset, _context) when is_struct(changeset, Ash.Changeset) do
+    reverse_relationships = Ash.Changeset.get_attribute(changeset, :reverse_relationships)
+
+    cvlan = {:cvlan, hd(hd(reverse_relationships).characteristics).value}
+
+    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, avc: [cvlan])
+  end
 end

lib/nbn/resources/characteristic_values/avc_value.ex

@@ -10,19 +10,21 @@ defmodule DiffoExample.Nbn.AvcValue do
   """
   use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
 
+  alias DiffoExample.Nbn.BandwidthProfile
+
   jason do
-    pick [:cir, :pir]
+    pick [:cvlan, :bandwidth_profile]
     compact(true)
   end
 
   outstanding do
-    expect [:cir, :pir]
+    expect [:cvlan, :bandwidth_profile]
   end
 
   typed_struct do
-    field :cir, :integer, description: "Committed Information Rate in Mbps"
+    field :cvlan, :string, description: "the cvlan of the AVC, assigned by the related CVC"
 
-    field :pir, :integer, description: "Peak Information Rate in Mbps"
+    field :bandwidth_profile, BandwidthProfile, description: "the bandwidth profile of the AVC"
   end
 
   defimpl String.Chars do

lib/nbn/resources/characteristic_values/cvc_value.ex

@@ -11,16 +11,16 @@ defmodule DiffoExample.Nbn.CvcValue do
   use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
 
   jason do
-    pick [:cvc_id, :bandwidth]
+    pick [:svlan, :bandwidth]
     compact(true)
   end
 
   outstanding do
-    expect [:cvc_id, :bandwidth]
+    expect [:svlan, :bandwidth]
   end
 
   typed_struct do
-    field :cvc_id, :string, description: "the unique CVC identifier"
+    field :svlan, :string, description: "the svlan of the CVC, assigned by the related NNI Group"
 
     field :bandwidth, :integer, description: "total CVC bandwidth in Mbps"
   end

lib/nbn/resources/characteristic_values/ntd_value.ex

@@ -10,6 +10,8 @@ defmodule DiffoExample.Nbn.NtdValue do
   """
   use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
 
+  alias DiffoExample.Nbn.Technology
+
   jason do
     pick [:model, :serial_number, :technology]
     compact(true)
@@ -24,8 +26,7 @@ defmodule DiffoExample.Nbn.NtdValue do
 
     field :serial_number, :string, description: "the NTD serial number"
 
-    field :technology, :atom,
-      description: "the access technology (:FTTP, :FTTN, :HFC, :Fixed_Wireless)"
+    field :technology, Technology, description: "the access technology type", default: Technology.default
   end
 
   defimpl String.Chars do

lib/nbn/resources/characteristic_values/pri_value.ex

@@ -10,28 +10,29 @@ defmodule DiffoExample.Nbn.PriValue do
   """
   use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
 
-  @technologies [:FTTP, :FTTN, :FTTB, :FTTC, :HFC, :FixedWireless, :Satellite]
+  alias DiffoExample.Nbn.Technology
+  alias DiffoExample.Nbn.BandwidthProfile
+  alias DiffoExample.Nbn.Speeds
 
   jason do
-    pick [:avcid, :uniid, :speed, :technology]
+    pick [:avcid, :uniid, :technology, :bandwidth_profile, :speeds]
     compact(true)
   end
 
   outstanding do
-    expect [:circuit_id, :speed]
+    expect [:avcid, :uniid, :technology, :bandwidth_profile, :speeds]
   end
 
   typed_struct do
-    field :avcid, :string, description: "the avcid from the owne Avc Resource"
+    field :avcid, :string, description: "the avcid from the owned Avc Resource"
 
     field :uniid, :string, description: "the uniid from the owned Uni Resource"
 
-    field :speed, :integer, description: "the circuit download speed in Mbps"
+    field :technology, Technology, description: "the technology type"
 
-    field :technology, :atom,
-      description: "the access technology",
-      constraints: [one_of: @technologies],
-      default: :FTTP
+    field :bandwidth_profile, BandwidthProfile, description: "the bandwidth profile"
+
+    field :speeds, Speeds, description: "the downstream and upstream speeds in Mbps"
   end
 
   defimpl String.Chars do

lib/nbn/resources/characteristic_values/uni_value.ex

@@ -10,22 +10,23 @@ defmodule DiffoExample.Nbn.UniValue do
   """
   use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
 
+  alias DiffoExample.Nbn.Technology
+
   jason do
-    pick [:vlan_id, :bandwidth_profile, :technology]
+    pick [:port, :encapsulation, :technology]
     compact(true)
   end
 
   outstanding do
-    expect [:vlan_id, :technology]
+    expect [:port, :encapsulation, :technology]
   end
 
   typed_struct do
-    field :vlan_id, :integer, description: "the VLAN ID for the UNI"
+    field :port, :integer, description: "the port of the UNI, assigned by the related NTD"
 
-    field :bandwidth_profile, :string, description: "the bandwidth profile name for the UNI"
+    field :encapsulation, :string, description: "the encapsulation of the UNI"
 
-    field :technology, :atom,
-      description: "the access technology (:FTTP, :FTTN, :HFC, :Fixed_Wireless)"
+    field :technology, Technology, description: "the access technology type"
   end
 
   defimpl String.Chars do

lib/nbn/resources/cvc.ex

@@ -8,8 +8,8 @@ defmodule DiffoExample.Nbn.Cvc do
 
   Cvc - Connectivity Virtual Circuit Resource Instance
 
-  A CVC is the wholesale bandwidth product that aggregates one or more AVC
-  resources and terminates at an NNI Group resource. Each AVC has a related UNI.
+  A CVC is the wholesale bandwidth product that supports AVC and terminates at an NNI Group.
+  The CVC assigns cvlan to AVC.
   """
 
   alias Diffo.Provider.BaseInstance
@@ -42,7 +42,7 @@ defmodule DiffoExample.Nbn.Cvc do
 
   characteristics do
     characteristic :cvc, DiffoExample.Nbn.CvcValue
-    characteristic :cvlan_ids, Diffo.Provider.AssignableValue
+    characteristic :cvlans, Diffo.Provider.AssignableValue
   end
 
   actions do
@@ -86,7 +86,7 @@ defmodule DiffoExample.Nbn.Cvc do
       argument :assignment, :struct, constraints: [instance_of: Assignment]
 
       change after_action(fn changeset, result, _context ->
-               with {:ok, result} <- Assigner.assign(result, changeset, :cvlan_ids, :cvlan_id),
+               with {:ok, result} <- Assigner.assign(result, changeset, :cvlans, :cvlan),
                     {:ok, result} <- Nbn.get_cvc_by_id(result.id),
                     do: {:ok, result}
              end)
@@ -102,15 +102,33 @@ defmodule DiffoExample.Nbn.Cvc do
                     do: {:ok, result}
              end)
     end
-  end
 
-  attributes do
-    attribute :cvcid, :string do
-      default &DiffoExample.Nbn.Cvc.identifier/0
+    update :mine do
+      description "updates the CVC with data mined from related instances"
+      argument :characteristic_value_updates, {:array, :term}
+
+      change before_action(fn changeset, context ->
+               DiffoExample.Nbn.Cvc.mine_related(changeset, context)
+             end)
+
+      change after_action(fn changeset, result, _context ->
+               with {:ok, result} <- Characteristic.update_values(result, changeset),
+                    {:ok, result} <- Nbn.get_cvc_by_id(result.id),
+                    do: {:ok, result}
+             end)
     end
   end
 
   def identifier() do
     DiffoExample.Nbn.Util.identifier("CVC")
   end
+
+  # mines related resource to characteristics
+  def mine_related(changeset, _context) when is_struct(changeset, Ash.Changeset) do
+    reverse_relationships = Ash.Changeset.get_attribute(changeset, :reverse_relationships)
+
+    svlan = {:svlan, hd(hd(reverse_relationships).characteristics).value}
+
+    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, cvc: [svlan])
+  end
 end

lib/nbn/resources/nbn_ethernet.ex

@@ -8,9 +8,7 @@ defmodule DiffoExample.Nbn.NbnEthernet do
 
   NbnEthernet - NBN Ethernet access Resource Instance
 
-  An NBN Ethernet access comprising a dedicated UNI and AVC resource.
-  The access is related to its UNI, which in turn is aggregated by a CVC
-  that terminates at an NNI Group.
+  An NBN Ethernet access comprises of dedicated UNI and AVC resources.
   """
 
   alias Diffo.Provider.BaseInstance
@@ -19,6 +17,7 @@ defmodule DiffoExample.Nbn.NbnEthernet do
   alias Diffo.Provider.Instance.ActionHelper
 
   alias DiffoExample.Nbn
+  alias DiffoExample.Nbn.Util
 
   use Ash.Resource,
     fragments: [BaseInstance],
@@ -117,12 +116,25 @@ defmodule DiffoExample.Nbn.NbnEthernet do
     forward_relationships = Ash.Changeset.get_attribute(changeset, :forward_relationships)
 
     pri_updates =
-      Enum.into(forward_relationships, [], fn forward_relationship ->
+      Enum.reduce(forward_relationships, [], fn forward_relationship, acc ->
         {:ok, related} = Diffo.Provider.get_instance_by_id(forward_relationship.target_id)
-        {alias_to_id(forward_relationship.alias), related.name}
+        related_name = {alias_to_id(forward_relationship.alias), related.name}
+        case forward_relationship.alias do
+          :uni ->
+            # extract technology from uni characteristic
+            [{:technology, Util.extract(related.characteristics, :uni, :technology)} | [ related_name | acc]]
+          :avc ->
+            # extract bandwidth_profile from avc characteristic
+            [{:bandwidth_profile, Util.extract(related.characteristics, :avc, :bandwidth_profile)} | [ related_name | acc]]
+          _ ->
+           [ related_name | acc]
+        end
       end)
 
-    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, pri: pri_updates)
+    # calculate the speeds from the extracted technology and bandwidth_profile
+    speeds = {:speeds, Util.speeds(Keyword.get(pri_updates, :bandwidth_profile), Keyword.get(pri_updates, :technology))}
+
+    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, pri: [speeds | pri_updates])
   end
 
   defp alias_to_id(alias) when is_atom(alias) do