Merge pull request #1 from PelionIoT/Initial_Creation

Creation of Edge Resource Mananger.

.github/workflows/build.yml

@@ -0,0 +1,40 @@
+name: Build
+on: push
+
+jobs:
+  build-standalone:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up golang
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.21'
+      - name: Run the build
+        run: go build -o edge-resource-manager edge-resource-manager.go
+      - name: Run go-vet
+        run: go vet ./...
+      - name: Run Golint
+        run: |
+          sudo apt-get update
+          sudo apt-get install golint
+          # Remove the vendor folder - we don't need to check that.
+          rm -rf vendor
+          golint ./... >golint_output
+          lines=$(wc -l < "golint_output")
+          if [[ $lines -gt 0 ]]; then
+              cat golint_output
+              exit 1
+          fi
+      - name: Check yq compliancy
+        run: |
+          sudo snap install yq
+          yq -r "." <izuma-base-config.yaml >yqout.yaml
+          if diff -u izuma-base-config.yaml yqout.yaml
+          then
+            echo "yq compliancy check passed"
+          else
+            echo "yq compliancy check failed"
+            exit 1
+          fi

.github/workflows/static-checks.yml

@@ -0,0 +1,43 @@
+name: Static checks - misspell
+on: push
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: egde-resource-mgr-'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  static-checks:
+    runs-on: ubuntu-22.04
+    env:
+      SUMMARY_FILE: summary.log
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Install Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+
+      # Need to run this 1st, so that the other log files do not cause unnecessary findings
+      - name: Run misspell
+        if: always()
+        run: |
+            # Remove the vendor folder - we don't need to check that.
+            rm -rf vendor
+            go install github.com/golangci/misspell/cmd/misspell@latest
+            misspell -i mosquitto . >misspell.log
+            echo "## Summary" >>$SUMMARY_FILE
+            echo "### misspell" >>$SUMMARY_FILE
+            cat misspell.log >>$SUMMARY_FILE
+            lines=$(wc -l < "misspell.log")
+            if [[ $lines -gt 0 ]]; then
+              echo "Misspell has findings, fail."
+              echo "TEST_FAIL=true" >> $GITHUB_ENV
+              exit 1
+            else
+                echo "No findings." >>$SUMMARY_FILE
+            fi
+      - name: Write summary
+        if: always()
+        run: cat $SUMMARY_FILE >>$GITHUB_STEP_SUMMARY

.gitignore

@@ -0,0 +1 @@
+edge-resource-manager

CHANGELOG.md

@@ -0,0 +1,8 @@
+## Changelog for Edge Resource Manager
+
+
+### Release 1.0.0
+
+- Initial release. 
+
+

LICENSE

@@ -0,0 +1,176 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+

README.md

@@ -1 +1,40 @@
-# gateway-resource-manager
+# Edge Resource Manager
+
+The Edge Resource Manager adds LwM2M resources to an Edge device at runtime.
+
+It achieves this by communicating to edge-core using the gateway resource manager REST API.
+
+The API is detailed in [grm-json-rpc](https://developer.izumanetworks.com/docs/device-management-edge/latest/managing/grm-json-rpc.html)
+
+## Configuration
+
+The edge-resource manager takes a configuration file as its input that describes the resources that are to be added to edge-core.
+
+The file [`izuma-base-config.yaml`](izuma-base-config.yaml) provides an example of this configuration file. It is expected that each use case of edge-resource-manager provides their own implementation of the configuration file.
+
+The configuration file contains information about how to connect to edge-core and the LwM2M resources than should be added.
+
+The **name** and **enable** fields of each LwM2M resource are read only resources. They cannot be changed at runtime.
+
+## Execution
+
+The edge-resource-manager should be started as a systemd service on the gateway.
+
+A typical service file is shown below:
+
+```
+[Unit]
+Description=edge-resource-manager: Adds gateway capability resources.
+Requires=edge-proxy.service
+After=edge-proxy.service
+
+[Service]
+Restart=always
+RestartSec=5s
+ExecStart=/usr/bin/edge-resource-manager -config /etc/edge/izuma-base-config.yaml
+StandardOutput=journal
+StandardError=journal
+
+[Install]
+WantedBy=multi-user.target
+```

edge-resource-manager.go

@@ -0,0 +1,63 @@
+/*
+Copyright (c) 2023, Izuma Networks
+
+SPDX-License-Identifier: Apache-2.0
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package main
+
+import (
+    "flag"
+    "os"
+    "github.com/op/go-logging"
+    "github.com/PelionIoT/edge-resource-manager/resourcemanagerconfig"
+    "github.com/PelionIoT/edge-resource-manager/resourcemanager"
+)
+
+var log = logging.MustGetLogger("EdgeResourceManager")
+func init() {
+    backend := logging.NewLogBackend(os.Stderr, "", 0)
+    format := logging.MustStringFormatter(
+        `%{color}%{time:15:04:05.000} ▶ %{level:.4s} %{callpath}%{color:reset} %{message}`,
+    )
+    backendFormatter := logging.NewBackendFormatter(backend, format)
+    logging.SetBackend(backendFormatter)
+}
+
+
+func main() {
+
+    log.Info("edge-resource-manager starting.")
+
+    configFlag := flag.String("config", "./izuma-base-config.yaml", "Config path")
+    flag.Parse()
+
+    if configFlag != nil {
+        log.Infof("config file: %s", *configFlag)
+    }
+
+    // Initialization starts off with reading in the entire config file,
+    // which also creates and populated the config macro variable dictionary,
+    // which is used in different parts of the configs
+
+    config := new(resourcemanagerconfig.YAMLConfig)
+    err := config.LoadFromFile(*configFlag)
+
+    if err != nil {
+        log.Errorf("Critical error. Config file parse failed --> %s", err.Error())
+        os.Exit(1)
+    }
+
+    resourcemanager.Run(config.EdgeCapabilities)
+
+}
+

go.mod

@@ -0,0 +1,10 @@
+module github.com/PelionIoT/edge-resource-manager
+
+go 1.21
+
+require (
+	github.com/gorilla/websocket v1.5.1 // indirect
+	github.com/op/go-logging v0.0.0-20160315200505-970db520ece7 // indirect
+	golang.org/x/net v0.17.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+)