improved identifiers

Author: matt-beanland

lib/access/util.ex

@@ -13,9 +13,13 @@ defmodule DiffoExample.Access.Util do
 
   alias Diffo.Provider.Assignment
 
-  def assignments(instance, type) do
+  @doc """
+  Lists things that are assigned_to an Instance, as Assignments
+  """
+  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

@@ -33,6 +33,7 @@ defmodule DiffoExample.Nbn do
       define :build_nbn_ethernet, action: :build
       define :define_nbn_ethernet, action: :define
       define :relate_nbn_ethernet, action: :relate
+      define :mine_nbn_ethernet, action: :mine
     end
 
     resource Uni do

lib/nbn/resources/avc.ex

@@ -43,14 +43,16 @@ defmodule DiffoExample.Nbn.Avc do
   actions do
     create :build do
       description "creates a new AVC resource instance"
-      accept [:id, :name, :type, :which]
+      accept [:id, :which]
       argument :specified_by, :uuid, public?: false
       argument :relationships, {:array, :struct}
       argument :features, {:array, :uuid}, public?: false
       argument :characteristics, {:array, :uuid}, public?: false
       argument :places, {:array, :struct}
       argument :parties, {:array, :struct}
 
+      change set_attribute(:name, &DiffoExample.Nbn.Avc.identifier/0)
+
       change set_attribute(:type, :resource)
 
       change before_action(fn changeset, _context -> ActionHelper.build_before(changeset) end)
@@ -85,4 +87,8 @@ defmodule DiffoExample.Nbn.Avc do
              end)
     end
   end
+
+  def identifier() do
+    DiffoExample.Nbn.Util.identifier("AVC")
+  end
 end

…racteristic_values/nbn_ethernet_value.ex …urces/characteristic_values/pri_value.exlib/nbn/resources/characteristic_values/nbn_ethernet_value.ex renamed to lib/nbn/resources/characteristic_values/pri_value.ex lib/nbn/resources/characteristic_values/nbn_ethernet_value.ex renamed to lib/nbn/resources/characteristic_values/pri_value.ex

@@ -2,16 +2,18 @@
 #
 # SPDX-License-Identifier: MIT
 
-defmodule DiffoExample.Nbn.NbnEthernetValue do
+defmodule DiffoExample.Nbn.PriValue do
   @moduledoc """
   Diffo - TMF Service and Resource Management with a difference
 
-  NbnEthernetValue - AshTyped Struct for NBN Ethernet Circuit Characteristic Value
+  NbnEthernetValue - AshTyped Struct for NBN Ethernet Access Characteristic Value
   """
   use Ash.TypedStruct, extensions: [AshJason.TypedStruct, AshOutstanding.TypedStruct]
 
+  @technologies [:FTTP, :FTTN, :FTTB, :FTTC, :HFC, :FixedWireless, :Satellite]
+
   jason do
-    pick [:circuit_id, :speed, :technology]
+    pick [:avcid, :uniid, :speed, :technology]
     compact(true)
   end
 
@@ -20,12 +22,16 @@ defmodule DiffoExample.Nbn.NbnEthernetValue do
   end
 
   typed_struct do
-    field :circuit_id, :string, description: "the unique NBN circuit identifier"
+    field :avcid, :string, description: "the avcid from the owne 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, :atom,
-      description: "the access technology (:FTTP, :FTTN, :HFC, :Fixed_Wireless)"
+      description: "the access technology",
+      constraints: [one_of: @technologies],
+      default: :FTTP
   end
 
   defimpl String.Chars do

lib/nbn/resources/cvc.ex

@@ -34,7 +34,9 @@ defmodule DiffoExample.Nbn.Cvc do
     id "d4e5f6a7-8b9c-4d0e-bf1a-3b4c5d6e7f8a"
     name "cvc"
     type :resourceSpecification
+
     description "A Connectivity Virtual Circuit Resource Instance that aggregates AVCs and terminates at an NNI Group"
+
     category "Network Resource"
   end
 
@@ -46,14 +48,16 @@ defmodule DiffoExample.Nbn.Cvc do
   actions do
     create :build do
       description "creates a new CVC resource instance"
-      accept [:id, :name, :type, :which]
+      accept [:id, :which]
       argument :specified_by, :uuid, public?: false
       argument :relationships, {:array, :struct}
       argument :features, {:array, :uuid}, public?: false
       argument :characteristics, {:array, :uuid}, public?: false
       argument :places, {:array, :struct}
       argument :parties, {:array, :struct}
 
+      change set_attribute(:name, &DiffoExample.Nbn.Cvc.identifier/0)
+
       change set_attribute(:type, :resource)
 
       change before_action(fn changeset, _context -> ActionHelper.build_before(changeset) end)
@@ -99,4 +103,14 @@ defmodule DiffoExample.Nbn.Cvc do
              end)
     end
   end
+
+  attributes do
+    attribute :cvcid, :string do
+      default &DiffoExample.Nbn.Cvc.identifier/0
+    end
+  end
+
+  def identifier() do
+    DiffoExample.Nbn.Util.identifier("CVC")
+  end
 end

lib/nbn/resources/nbn_ethernet.ex

@@ -6,10 +6,10 @@ defmodule DiffoExample.Nbn.NbnEthernet do
   @moduledoc """
   Diffo - TMF Service and Resource Management with a difference
 
-  NbnEthernet - NBN Ethernet Circuit Resource Instance
+  NbnEthernet - NBN Ethernet access Resource Instance
 
-  An NBN Ethernet circuit comprising a dedicated UNI and AVC resource.
-  The circuit is related to its UNI, which in turn is aggregated by a CVC
+  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.
   """
 
@@ -25,33 +25,39 @@ defmodule DiffoExample.Nbn.NbnEthernet do
     domain: Nbn
 
   resource do
-    description "An Ash Resource representing an NBN Ethernet Circuit"
+    description "An Ash Resource representing an NBN Ethernet access"
     plural_name :NbnEthernets
   end
 
   specification do
     id "f2a4c6e8-1b3d-4f5a-8c7e-9d0b2e4f6a8c"
     name "nbnEthernet"
     type :resourceSpecification
-    description "An NBN Ethernet Circuit comprising a dedicated UNI and AVC"
+    description "An NBN Ethernet access comprising a dedicated UNI and AVC"
     category "Network Resource"
   end
 
   characteristics do
-    characteristic :nbn_ethernet, DiffoExample.Nbn.NbnEthernetValue
+    characteristic :pri, DiffoExample.Nbn.PriValue
+    # values do
+    #  value :uniid, DiffoExample.Nbn.Uni, :owns, :name
+    #  value :avcid, DiffoExample.Nbn.Avc, :owns, :name
+    # end
   end
 
   actions do
     create :build do
-      description "creates a new NBN Ethernet circuit resource instance"
-      accept [:id, :name, :type, :which]
+      description "creates a new NBN Ethernet access resource instance"
+      accept [:id, :which]
       argument :specified_by, :uuid, public?: false
       argument :relationships, {:array, :struct}
       argument :features, {:array, :uuid}, public?: false
       argument :characteristics, {:array, :uuid}, public?: false
       argument :places, {:array, :struct}
       argument :parties, {:array, :struct}
 
+      change set_attribute(:name, &DiffoExample.Nbn.NbnEthernet.identifier/0)
+
       change set_attribute(:type, :resource)
 
       change before_action(fn changeset, _context -> ActionHelper.build_before(changeset) end)
@@ -65,7 +71,7 @@ defmodule DiffoExample.Nbn.NbnEthernet do
     end
 
     update :define do
-      description "defines the NBN Ethernet circuit"
+      description "defines the NBN Ethernet access"
       argument :characteristic_value_updates, {:array, :term}
 
       change after_action(fn changeset, result, _context ->
@@ -76,7 +82,7 @@ defmodule DiffoExample.Nbn.NbnEthernet do
     end
 
     update :relate do
-      description "relates the NBN Ethernet circuit with other instances (e.g. UNI)"
+      description "relates the NBN Ethernet access with other instances (e.g. UNI)"
       argument :relationships, {:array, :struct}
 
       change after_action(fn changeset, result, _context ->
@@ -85,5 +91,42 @@ defmodule DiffoExample.Nbn.NbnEthernet do
                     do: {:ok, result}
              end)
     end
+
+    update :mine do
+      description "updates the NBN Ethernet access with data mined from related instances"
+      argument :characteristic_value_updates, {:array, :term}
+
+      change before_action(fn changeset, context ->
+               DiffoExample.Nbn.NbnEthernet.mine_related(changeset, context)
+             end)
+
+      change after_action(fn changeset, result, _context ->
+               with {:ok, result} <- Characteristic.update_values(result, changeset),
+                    {:ok, result} <- Nbn.get_nbn_ethernet_by_id(result.id),
+                    do: {:ok, result}
+             end)
+    end
+  end
+
+  def identifier() do
+    DiffoExample.Nbn.Util.identifier("PRI")
+  end
+
+  # mines related resource to characteristics
+  def mine_related(changeset, _context) when is_struct(changeset, Ash.Changeset) do
+    forward_relationships = Ash.Changeset.get_attribute(changeset, :forward_relationships)
+
+    pri_updates =
+      Enum.into(forward_relationships, [], fn forward_relationship ->
+        {:ok, related} = Diffo.Provider.get_instance_by_id(forward_relationship.target_id)
+        {alias_to_id(forward_relationship.alias), related.name}
+      end)
+
+    Ash.Changeset.force_set_argument(changeset, :characteristic_value_updates, pri: pri_updates)
+  end
+
+  defp alias_to_id(alias) when is_atom(alias) do
+    (Atom.to_string(alias) <> "id")
+    |> String.to_atom()
   end
 end

lib/nbn/resources/nni.ex

@@ -44,7 +44,7 @@ defmodule DiffoExample.Nbn.Nni do
   actions do
     create :build do
       description "creates a new NNI resource instance"
-      accept [:id, :name, :type, :which]
+      accept [:id, :which]
       argument :specified_by, :uuid, public?: false
       argument :relationships, {:array, :struct}
       argument :features, {:array, :uuid}, public?: false
@@ -54,6 +54,8 @@ defmodule DiffoExample.Nbn.Nni do
 
       change set_attribute(:type, :resource)
 
+      change set_attribute(:name, &DiffoExample.Nbn.Nni.identifier/0)
+
       change before_action(fn changeset, _context -> ActionHelper.build_before(changeset) end)
 
       change after_action(fn changeset, result, _context ->
@@ -85,5 +87,9 @@ defmodule DiffoExample.Nbn.Nni do
                     do: {:ok, result}
              end)
     end
+
+    def identifier() do
+      DiffoExample.Nbn.Util.identifier("NNI")
+    end
   end
 end

lib/nbn/resources/nni_group.ex

@@ -46,7 +46,7 @@ defmodule DiffoExample.Nbn.NniGroup do
   actions do
     create :build do
       description "creates a new NNI Group resource instance"
-      accept [:id, :name, :type, :which]
+      accept [:id, :name, :which]
       argument :specified_by, :uuid, public?: false
       argument :relationships, {:array, :struct}
       argument :features, {:array, :uuid}, public?: false

lib/nbn/resources/ntd.ex

@@ -43,7 +43,7 @@ defmodule DiffoExample.Nbn.Ntd do
   actions do
     create :build do
       description "creates a new NTD resource instance"
-      accept [:id, :name, :type, :which]
+      accept [:id, :which]
       argument :specified_by, :uuid, public?: false
       argument :relationships, {:array, :struct}
       argument :features, {:array, :uuid}, public?: false
@@ -53,6 +53,8 @@ defmodule DiffoExample.Nbn.Ntd do
 
       change set_attribute(:type, :resource)
 
+      change set_attribute(:name, &DiffoExample.Nbn.Ntd.identifier/0)
+
       change before_action(fn changeset, _context -> ActionHelper.build_before(changeset) end)
 
       change after_action(fn changeset, result, _context ->
@@ -85,4 +87,8 @@ defmodule DiffoExample.Nbn.Ntd do
              end)
     end
   end
+
+  def identifier() do
+    DiffoExample.Nbn.Util.identifier("NTD")
+  end
 end

lib/nbn/resources/uni.ex

@@ -9,7 +9,7 @@ defmodule DiffoExample.Nbn.Uni do
   Uni - User Network Interface Resource Instance
 
   A UNI is the physical/logical interface at the customer premises. It is
-  related to an NTD resource and to its parent NBN Ethernet circuit.
+  related to an NTD resource and to its parent NBN Ethernet access.
   It is related to an AVC resource, which is in turn aggregated by a CVC.
   """
 
@@ -33,7 +33,7 @@ defmodule DiffoExample.Nbn.Uni do
     id "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
     name "uni"
     type :resourceSpecification
-    description "A UNI Resource Instance related to an NTD and an NBN Ethernet circuit"
+    description "A UNI Resource Instance related to an NTD and an NBN Ethernet access"
     category "Network Resource"
   end
 
@@ -44,7 +44,7 @@ defmodule DiffoExample.Nbn.Uni do
   actions do
     create :build do
       description "creates a new UNI resource instance"
-      accept [:id, :name, :type, :which]
+      accept [:id, :which]
       argument :specified_by, :uuid, public?: false
       argument :relationships, {:array, :struct}
       argument :features, {:array, :uuid}, public?: false
@@ -54,6 +54,8 @@ defmodule DiffoExample.Nbn.Uni do
 
       change set_attribute(:type, :resource)
 
+      change set_attribute(:name, &DiffoExample.Nbn.Uni.identifier/0)
+
       change before_action(fn changeset, _context -> ActionHelper.build_before(changeset) end)
 
       change after_action(fn changeset, result, _context ->
@@ -76,7 +78,7 @@ defmodule DiffoExample.Nbn.Uni do
     end
 
     update :relate do
-      description "relates the UNI with other instances (e.g. NTD, NBN Ethernet circuit)"
+      description "relates the UNI with other instances (e.g. NTD, NBN Ethernet access)"
       argument :relationships, {:array, :struct}
 
       change after_action(fn changeset, result, _context ->
@@ -86,4 +88,8 @@ defmodule DiffoExample.Nbn.Uni do
              end)
     end
   end
+
+  def identifier() do
+    DiffoExample.Nbn.Util.identifier("UNI")
+  end
 end