Initial sync

from https://github.com/Seagate/cfm tag v1.2.0

.gitignore

@@ -0,0 +1,19 @@
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+/cfm-service
+/cfm-cli
+/cxl-host
+/cmd/cxl-host/cxl-host
+
+# Folders
+_obj
+pkg/client
+pkg/openapi
+pkg/redfishapi
+webui/src/axios
+
+# Ignore the accounts file created during cxl-host execution
+/cxl-host-accounts.json
+/cmd/cxl-host/cxl-host-accounts.json
+
+# Ignore the module files
+webui/node_modules/

LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2024 Open Compute Project
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 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.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

Makefile

@@ -0,0 +1,137 @@
+# Copyright (c) 2024 Seagate Technology LLC and/or its Affiliates
+.PHONY: help clean local run run-defaults validate generate generate-openapi generate-client generate-redfish generate-axios webui-dist docker-image fmt test-go vet-go test-go-backend
+
+APP_NAME := cfm-service
+CLIAPP_NAME := cfm-cli
+CONF_NAME := cfm-service.conf
+OPENAPI_YAML := api/cfm-openapi.yaml
+OPENAPI_REDFISH_YAML := api/redfish-openapi.yaml
+GO_VERSION := 1.22.1
+GO_INSTALL_LOCATION := /usr/local/go/bin/
+GOFMT_OPTS := $(GO_INSTALL_LOCATION)gofmt -w /local
+GENERATE_USER := $(shell id -u ${USER}):$(shell id -g ${USER})
+
+help:
+	@echo ""
+	@echo "-----------------------------------------------------------------------------------"
+	@echo "make clean-service        - Remove local $(APP_NAME) executable"
+	@echo "make clean-cli            - Remove local $(CLIAPP_NAME) executable"
+	@echo "make clean-go             - Remove all Go executables"
+	@echo "make build-service        - Build local $(APP_NAME) executable"
+	@echo "make build-cli            - Build local $(CLIAPP_NAME) executable"
+	@echo "make build-go             - Build local $(APP_NAME) and $(CLIAPP_NAME) executables"
+	@echo "make build-docker-cfm     - Build a local docker image for the cfm software suite"
+	@echo "make run-service          - Build and run a local $(APP_NAME) executable using config file $(CONF_NAME)"
+	@echo "make run-service-defaults - Build and run a local $(APP_NAME) executable using its' internal config defaults"
+	@echo "make validate             - Validate the openapi specification using openapi-generator-cli"
+	@echo "make generate             - Generate supporting code for the whole suite using openapi-generator-cli"
+	@echo "make generate-openapi     - Generate go server code for the openapi specification using openapi-generator-cli"
+	@echo "make generate-client      - Generate go client code for the openapi specification using openapi-generator-cli"
+	@echo "make generate-redfish     - Generate go server code for the redfish specification using openapi-generator-cli"
+	@echo "make generate-axios       - Generate axios server code for the openapi specification using openapi-generator-cli"
+	@echo "make fmt-go               - Run gofmt"
+	@echo "make test-go              - Run all Go tests"
+	@echo "make vet-go               - Run go vet"
+	@echo "make test-go-backend      - Run Go unit tests on the backend go code"
+	@echo ""
+
+clean-service:
+	@echo "Clean up cfm-service..."
+	go clean
+	rm -f $(APP_NAME)
+
+clean-cli:
+	@echo "Clean up cfm-cli..."
+	go clean
+	rm -f $(CLIAPP_NAME)
+
+clean-go:
+	@echo "Clean up..."
+	go clean
+	rm -f $(APP_NAME) $(CLIAPP_NAME)
+
+build-service: clean-service
+	@echo "Building cfm-service executable..."
+	go build -o $(APP_NAME) -ldflags "-X main.buildTime=`date -u '+%Y-%m-%dT%H:%M:%S'`" ./cmd/$(APP_NAME)/main.go
+	ls -lh $(APP_NAME)
+
+build-cli: clean-cli
+	@echo "Building cfm-cli executable..."
+	go build -o $(CLIAPP_NAME) -ldflags "-X main.buildTime=`date -u '+%Y-%m-%dT%H:%M:%S'`" ./cmd/$(CLIAPP_NAME)/main.go
+	ls -lh $(CLIAPP_NAME)
+
+build-go: clean-go
+	@echo "Building cfm Go executables..."
+	go build -o $(APP_NAME) -ldflags "-X main.buildTime=`date -u '+%Y-%m-%dT%H:%M:%S'`" ./cmd/$(APP_NAME)/main.go
+	go build -o $(CLIAPP_NAME) -ldflags "-X main.buildTime=`date -u '+%Y-%m-%dT%H:%M:%S'`" ./cmd/$(CLIAPP_NAME)/main.go
+	ls -lh $(APP_NAME) $(CLIAPP_NAME)
+
+build-docker-cfm:
+	@echo "Building local docker image of cfm software suite..."
+	docker build --no-cache -t cfm -f docker/Dockerfile .
+
+install-webui-dist: build-webui-dist
+	@echo "Installing webui distro into $(APP_NAME)..."
+	mkdir -p ./services/webui/dist
+	cp ./webui/dist ./services/webui/dist
+
+run-service: build-service
+	@echo "Running $(APP_NAME) using config file $(CONF_NAME) (Ctrl-C to stop)"
+	./$(APP_NAME) -config $(CONF_NAME)
+
+run-service-defaults: build-service
+	@echo "Running $(APP_NAME) using config defaults (Ctrl-C to stop)"
+	./$(APP_NAME)
+
+validate:
+	@echo "Validating $(OPENAPI_YAML) using openapi-generator-cli"
+	docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.0.0 version
+	docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.0.0 validate -i /local/$(OPENAPI_YAML)
+
+generate-openapi:
+	@echo "Generating $(OPENAPI_YAML) go server using openapi-generator-cli"
+	docker run -u $(GENERATE_USER) --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.0.0 generate -i /local/$(OPENAPI_YAML) -g go-server -o /local/pkg/openapi --additional-properties=sourceFolder=,outputAsLibrary=true,router=mux,serverPort=8080,enumClassPrefix=true -t /local/api/templates/go-server --skip-validate-spec
+	@echo "Format files after generation to conform to project standard"
+	docker run --rm -v ${PWD}:/local golang:$(GO_VERSION) $(GOFMT_OPTS)
+
+generate-client:
+	@echo "Generating $(OPENAPI_YAML) go client using openapi-generator-cli"
+	docker run -u $(GENERATE_USER) --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.0.0 generate -i /local/$(OPENAPI_YAML) -g go -o /local/pkg/client -p isGoSubmodule=true,withGoMod=false --package-name client --ignore-file-override /local/api/ignore/.openapi-generator-ignore-client -t /local/api/templates/go
+	# workaround for withGoMod=false not functioning with openapi-generator
+	rm pkg/client/go.mod
+	rm pkg/client/go.sum
+
+	@echo "Format files after generation to conform to project standard"
+	docker run --rm -v ${PWD}:/local golang:$(GO_VERSION) $(GOFMT_OPTS)
+
+generate-redfish:
+	@echo "Generating $(OPENAPI_YAML) redfish server using openapi-generator-cli"
+	docker run -u $(GENERATE_USER) --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.0.0 generate -i /local/$(OPENAPI_REDFISH_YAML) -g go-server -o /local/pkg/redfishapi --package-name redfishapi --additional-properties=sourceFolder=,outputAsLibrary=true,router=mux,serverPort=8080,enumClassPrefix=true -t /local/api/templates/go-server --skip-validate-spec
+	@echo "Format files after generation to conform to project standard"
+	docker run --rm -v ${PWD}:/local golang:$(GO_VERSION) $(GOFMT_OPTS)
+	@echo "Apply local patch for xml response fix"
+	git apply api/patch/Apply-xml-workaround-to-fix-metadata-response.patch
+	@echo "Apply local patch for missing import"
+	git apply api/patch/fix-missing-import.patch
+
+generate-axios:
+	@echo "Generating $(OPENAPI_YAML) axios server using openapi-generator-cli"
+	docker run -u $(GENERATE_USER) --rm -v ${PWD}:/local openapitools/openapi-generator-cli:v7.0.0 generate -i /local/$(OPENAPI_YAML) -g typescript-axios -o /local/webui/src/axios --skip-validate-spec
+
+generate: generate-openapi generate-client generate-redfish generate-axios
+
+fmt-go:
+	@echo "Format check(Go)"
+	docker run --rm -v ${PWD}:/local golang:$(GO_VERSION) $(GOFMT_OPTS)
+
+test-go: | vet-go
+	@echo "Running all Go tests"
+	go test -v ./...
+
+vet-go:
+	@echo "Running go vet"
+	go vet ./...
+
+test-go-backend:
+	@echo "Running Go tests on pkg/backend"
+	go test -v ./pkg/backend