From 830d17ba2774b07d0d809e88bc8cff3a1dfbfc91 Mon Sep 17 00:00:00 2001 From: Eishun Kondoh Date: Wed, 10 Oct 2018 17:16:28 +0900 Subject: [PATCH] example: Add BGP EVPN example --- examples/evpn_router/.formatter.exs | 4 +++ examples/evpn_router/.gitignore | 24 +++++++++++++++ examples/evpn_router/README.md | 21 +++++++++++++ examples/evpn_router/config/config.exs | 30 +++++++++++++++++++ examples/evpn_router/lib/evpn_router.ex | 18 +++++++++++ .../lib/evpn_router/application.ex | 20 +++++++++++++ examples/evpn_router/mix.exs | 29 ++++++++++++++++++ .../evpn_router/test/evpn_router_test.exs | 8 +++++ examples/evpn_router/test/test_helper.exs | 1 + 9 files changed, 155 insertions(+) create mode 100644 examples/evpn_router/.formatter.exs create mode 100644 examples/evpn_router/.gitignore create mode 100644 examples/evpn_router/README.md create mode 100644 examples/evpn_router/config/config.exs create mode 100644 examples/evpn_router/lib/evpn_router.ex create mode 100644 examples/evpn_router/lib/evpn_router/application.ex create mode 100644 examples/evpn_router/mix.exs create mode 100644 examples/evpn_router/test/evpn_router_test.exs create mode 100644 examples/evpn_router/test/test_helper.exs diff --git a/examples/evpn_router/.formatter.exs b/examples/evpn_router/.formatter.exs new file mode 100644 index 0000000..d2cda26 --- /dev/null +++ b/examples/evpn_router/.formatter.exs @@ -0,0 +1,4 @@ +# Used by "mix format" +[ + inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] +] diff --git a/examples/evpn_router/.gitignore b/examples/evpn_router/.gitignore new file mode 100644 index 0000000..22b8666 --- /dev/null +++ b/examples/evpn_router/.gitignore @@ -0,0 +1,24 @@ +# The directory Mix will write compiled artifacts to. +/_build/ + +# If you run "mix test --cover", coverage assets end up here. +/cover/ + +# The directory Mix downloads your dependencies sources to. +/deps/ + +# Where 3rd-party dependencies like ExDoc output generated docs. +/doc/ + +# Ignore .fetch files in case you like to edit your project deps locally. +/.fetch + +# If the VM crashes, it generates a dump, let's ignore it too. +erl_crash.dump + +# Also ignore archive artifacts (built via "mix archive.build"). +*.ez + +# Ignore package tarball (built via "mix hex.build"). +evpn_router-*.tar + diff --git a/examples/evpn_router/README.md b/examples/evpn_router/README.md new file mode 100644 index 0000000..a61ef93 --- /dev/null +++ b/examples/evpn_router/README.md @@ -0,0 +1,21 @@ +# EvpnRouter + +**TODO: Add description** + +## Installation + +If [available in Hex](https://hex.pm/docs/publish), the package can be installed +by adding `evpn_router` to your list of dependencies in `mix.exs`: + +```elixir +def deps do + [ + {:evpn_router, "~> 0.1.0"} + ] +end +``` + +Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) +and published on [HexDocs](https://hexdocs.pm). Once published, the docs can +be found at [https://hexdocs.pm/evpn_router](https://hexdocs.pm/evpn_router). + diff --git a/examples/evpn_router/config/config.exs b/examples/evpn_router/config/config.exs new file mode 100644 index 0000000..cec476b --- /dev/null +++ b/examples/evpn_router/config/config.exs @@ -0,0 +1,30 @@ +# This file is responsible for configuring your application +# and its dependencies with the aid of the Mix.Config module. +use Mix.Config + +# This configuration is loaded before any dependency and is restricted +# to this project. If another project depends on this project, this +# file won't be loaded nor affect the parent project. For this reason, +# if you want to provide default values for your application for +# 3rd-party users, it should be done in your "mix.exs" file. + +# You can configure your application as: +# +# config :evpn_router, key: :value +# +# and access this configuration in your application as: +# +# Application.get_env(:evpn_router, :key) +# +# You can also configure a 3rd-party app: +# +# config :logger, level: :info +# + +# It is also possible to import configuration files, relative to this +# directory. For example, you can emulate configuration per environment +# by uncommenting the line below and defining dev.exs, test.exs and such. +# Configuration from the imported file will override the ones defined +# here (which is why it is important to import them last). +# +# import_config "#{Mix.env()}.exs" diff --git a/examples/evpn_router/lib/evpn_router.ex b/examples/evpn_router/lib/evpn_router.ex new file mode 100644 index 0000000..ff3b8e5 --- /dev/null +++ b/examples/evpn_router/lib/evpn_router.ex @@ -0,0 +1,18 @@ +defmodule EvpnRouter do + @moduledoc """ + Documentation for EvpnRouter. + """ + + @doc """ + Hello world. + + ## Examples + + iex> EvpnRouter.hello() + :world + + """ + def hello do + :world + end +end diff --git a/examples/evpn_router/lib/evpn_router/application.ex b/examples/evpn_router/lib/evpn_router/application.ex new file mode 100644 index 0000000..a0281d4 --- /dev/null +++ b/examples/evpn_router/lib/evpn_router/application.ex @@ -0,0 +1,20 @@ +defmodule EvpnRouter.Application do + # See https://hexdocs.pm/elixir/Application.html + # for more information on OTP Applications + @moduledoc false + + use Application + + def start(_type, _args) do + # List all child processes to be supervised + children = [ + # Starts a worker by calling: EvpnRouter.Worker.start_link(arg) + # {EvpnRouter.Worker, arg}, + ] + + # See https://hexdocs.pm/elixir/Supervisor.html + # for other strategies and supported options + opts = [strategy: :one_for_one, name: EvpnRouter.Supervisor] + Supervisor.start_link(children, opts) + end +end diff --git a/examples/evpn_router/mix.exs b/examples/evpn_router/mix.exs new file mode 100644 index 0000000..39ae4d8 --- /dev/null +++ b/examples/evpn_router/mix.exs @@ -0,0 +1,29 @@ +defmodule EvpnRouter.MixProject do + use Mix.Project + + def project do + [ + app: :evpn_router, + version: "0.1.0", + elixir: "~> 1.7", + start_permanent: Mix.env() == :prod, + deps: deps() + ] + end + + # Run "mix help compile.app" to learn about applications. + def application do + [ + extra_applications: [:logger], + mod: {EvpnRouter.Application, []} + ] + end + + # Run "mix help deps" to learn about dependencies. + defp deps do + [ + # {:dep_from_hexpm, "~> 0.3.0"}, + # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}, + ] + end +end diff --git a/examples/evpn_router/test/evpn_router_test.exs b/examples/evpn_router/test/evpn_router_test.exs new file mode 100644 index 0000000..8c40ecb --- /dev/null +++ b/examples/evpn_router/test/evpn_router_test.exs @@ -0,0 +1,8 @@ +defmodule EvpnRouterTest do + use ExUnit.Case + doctest EvpnRouter + + test "greets the world" do + assert EvpnRouter.hello() == :world + end +end diff --git a/examples/evpn_router/test/test_helper.exs b/examples/evpn_router/test/test_helper.exs new file mode 100644 index 0000000..869559e --- /dev/null +++ b/examples/evpn_router/test/test_helper.exs @@ -0,0 +1 @@ +ExUnit.start()