From b3bcee469c705cb8fde2b9b1dba67cc0c8f91969 Mon Sep 17 00:00:00 2001 From: Gergin Darakov <47652045+ihatemodels@users.noreply.github.com> Date: Sun, 26 Nov 2023 22:46:33 +0200 Subject: [PATCH] add CI and build steps The commit adds Github Actions and Dockerfile for building a multi arch Go image --- .github/workflows/ci.yml | 62 ++++++++-- .golangci.yml | 29 +++++ Dockerfile | 27 +++++ LICENSE | 201 +++++++++++++++++++++++++++++++ README.md | 10 +- VERSION | 1 + internal/collector/gateways.go | 8 +- internal/collector/interfaces.go | 8 +- main.go | 12 +- opnsense/client.go | 4 +- opnsense/interfaces.go | 17 --- opnsense/utils.go | 20 +++ opnsense/utils_test.go | 12 ++ 13 files changed, 370 insertions(+), 41 deletions(-) create mode 100644 LICENSE create mode 100644 VERSION diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cc9083c..8b1d4d9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,28 +5,76 @@ on: tags: - "v*.*.*" pull_request: + paths: + - "go.sum" + - "go.mod" + - "**.go" + - ".github/workflows/ci.yml" + - ".golangci.yml" branches: - "main" jobs: tests: - name: Tests/Linters + name: Tests & Linters runs-on: ubuntu-latest - steps: - name: Set up Go uses: actions/setup-go@v2 with: - go-version: '1.21' # Use the version of Go your project requires - + go-version: '1.21' - name: Check out code uses: actions/checkout@v2 - - name: "Run Linters" - uses: golangci/golangci-lint-action@latest + uses: golangci/golangci-lint-action@v3 with: version: latest args: --verbose - - name: Run tests run: go test -v ./... + + + build: + name: Build & Publish on Tag + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + with: + fetch-depth: 1 + + - name: Get TAG + id: get_tag + run: echo TAG=${GITHUB_REF#refs/tags/} >> $GITHUB_ENV + + - name: Docker meta + id: meta + uses: docker/metadata-action@v4 + with: + images: | + st3ga/opnsense-exporter + tags: | + type=semver,pattern={{version}} + + - name: Set up QEMU + uses: docker/setup-qemu-action@v2 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Login to Docker Hub + if: github.event_name != 'pull_request' + uses: docker/login-action@v2 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + + - name: Release build + id: release_build + uses: docker/build-push-action@v3 + with: + platforms: linux/amd64,linux/arm/v6,linux/arm64 + build-args: | + Version=${{ env.TAG }} + context: . + push: ${{ github.event_name != 'pull_request' }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} \ No newline at end of file diff --git a/.golangci.yml b/.golangci.yml index e69de29..61e3735 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -0,0 +1,29 @@ +linters: + enable: + - misspell + - revive + disable: + - deadcode + - unused + - structcheck + - varcheck + +issues: + exclude-rules: + - path: _test.go + linters: + - errcheck + +linters-settings: + errcheck: + exclude-functions: + # Used in HTTP handlers, any error is handled by the server itself. + - (net/http.ResponseWriter).Write + # Never check for logger errors. + - (github.com/go-kit/log.Logger).Log + revive: + rules: + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter + - name: unused-parameter + severity: warning + disabled: true \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index e69de29..75d5e6f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -0,0 +1,27 @@ +FROM --platform=${BUILDPLATFORM:-linux/amd64} golang:1.21 as build + +ARG TARGETPLATFORM +ARG BUILDPLATFORM +ARG TARGETOS +ARG TARGETARCH +ARG Version + +WORKDIR /go/src/github.com/st3ga/opnsense-exporter +COPY . . + +RUN GOOS=${TARGETOS} GOARCH=${TARGETARCH} CGO_ENABLED=0 \ + go build \ + -tags osusergo,netgo \ + -ldflags "-s -w -X main.version=${Version}" \ + -o /usr/bin/opnsense-exporter . + +FROM --platform=${BUILDPLATFORM:-linux/amd64} gcr.io/distroless/static-debian12:latest + +LABEL org.opencontainers.image.source=https://github.com/st3ga/opnsense-exporter +LABEL org.opencontainers.image.version=${Version} +LABEL org.opencontainers.image.authors="the st3ga Authors admins@st3ga.com" +LABEL org.opencontainers.image.title="opnsense-exporter" +LABEL org.opencontainers.image.description="Prometheus exporter for OPNsense metrics" + +COPY --from=build /usr/bin/opnsense-exporter / +CMD ["/opnsense-exporter"] \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4f16d02 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 2023 the st3ga Authors + + 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. diff --git a/README.md b/README.md index f848b04..81e4ad7 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,12 @@ The OPNsense exporter enables you to monitor your OPNsense firewall from the API ## Table of Contents -0. **[About](#about)** -1. **[OPNsense User Permissions](#opnsense-user-permissions)** -2. **[Usage](#usage)** -3. **[Configuration](#configuration)** +**[About](#about)** +**[OPNsense User Permissions](#opnsense-user-permissions)** +**[Usage](#usage)** +**[Configuration](#configuration)** - **[SSL/TLS](#ssltls)** -4. **[Grafana Dashboard](#grafana-dashboard)** +**[Grafana Dashboard](#grafana-dashboard)** ## About diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..6c6aa7c --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +0.1.0 \ No newline at end of file diff --git a/internal/collector/gateways.go b/internal/collector/gateways.go index 2dbdf80..cf780f9 100644 --- a/internal/collector/gateways.go +++ b/internal/collector/gateways.go @@ -30,23 +30,23 @@ func (c *gatewaysCollector) Register(namespace, instanceLabel string, log log.Lo c.log = log c.instance = instanceLabel c.status = buildPrometheusDesc(c.subsystem, "status", - "Status of the gateway by name and address (1 = up, 0 = down, 2 = unkown)", + "Status of the gateway by name and address (1 = up, 0 = down, 2 = unknown)", []string{"name", "address"}, ) c.lossPercentage = buildPrometheusDesc( c.subsystem, "loss_percentage", "The current gateway loss percentage by name and address", - []string{"name", "adress"}, + []string{"name", "address"}, ) c.rtt = buildPrometheusDesc( c.subsystem, "rtt_milliseconds", "RTT is the average (mean) of the round trip time in milliseconds by name and address", - []string{"name", "adress"}, + []string{"name", "address"}, ) c.rttd = buildPrometheusDesc( c.subsystem, "rttd_milliseconds", "RTTd is the standard deviation of the round trip time in milliseconds by name and address", - []string{"name", "adress"}, + []string{"name", "address"}, ) } diff --git a/internal/collector/interfaces.go b/internal/collector/interfaces.go index 638d677..1814ca7 100644 --- a/internal/collector/interfaces.go +++ b/internal/collector/interfaces.go @@ -46,16 +46,16 @@ func (c *interfacesCollector) Register(namespace, instanceLabel string, log log. "Bytes received on this interface by interface name and device", []string{"interface", "device", "type"}, ) - c.bytesTransmited = buildPrometheusDesc(c.subsystem, "transmited_bytes_total", - "Bytes transmited on this interface by interface name and device", + c.bytesTransmited = buildPrometheusDesc(c.subsystem, "transmitted_bytes_total", + "Bytes transmitted on this interface by interface name and device", []string{"interface", "device", "type"}, ) c.multicastsReceived = buildPrometheusDesc(c.subsystem, "received_multicasts_total", "Multicasts received on this interface by interface name and device", []string{"interface", "device", "type"}, ) - c.multicastsTransmitted = buildPrometheusDesc(c.subsystem, "transmited_multicasts_total", - "Multicasts transmited on this interface by interface name and device", + c.multicastsTransmitted = buildPrometheusDesc(c.subsystem, "transmitted_multicasts_total", + "Multicasts transmitted on this interface by interface name and device", []string{"interface", "device", "type"}, ) c.inputErrors = buildPrometheusDesc(c.subsystem, "input_errors_total", diff --git a/main.go b/main.go index 6e824fa..c11fc21 100644 --- a/main.go +++ b/main.go @@ -92,8 +92,16 @@ func main() { Level: &promlog.AllowedLevel{}, Format: &promlog.AllowedFormat{}, } - promlogConfig.Level.Set(*logLevel) - promlogConfig.Format.Set(*logFormat) + + if err := promlogConfig.Level.Set(*logLevel); err != nil { + fmt.Fprintf(os.Stderr, "error setting log level: %v\n", err) + os.Exit(1) + } + + if err := promlogConfig.Format.Set(*logFormat); err != nil { + fmt.Fprintf(os.Stderr, "error setting log format: %v\n", err) + os.Exit(1) + } logger := promlog.New(promlogConfig) diff --git a/opnsense/client.go b/opnsense/client.go index 75a1990..c61ecce 100644 --- a/opnsense/client.go +++ b/opnsense/client.go @@ -41,7 +41,7 @@ type Client struct { } // NewClient creates a new OPNsense API Client -func NewClient(protocol, adress, key, secret, userAgentVersion string, sslInsecure bool, log log.Logger) (Client, error) { +func NewClient(protocol, address, key, secret, userAgentVersion string, sslInsecure bool, log log.Logger) (Client, error) { sslPool, err := x509.SystemCertPool() @@ -61,7 +61,7 @@ func NewClient(protocol, adress, key, secret, userAgentVersion string, sslInsecu } client := Client{ log: log, - baseURL: fmt.Sprintf("%s://%s", protocol, adress), + baseURL: fmt.Sprintf("%s://%s", protocol, address), key: key, secret: secret, gatewayLossRegex: gatewayLossRegex, diff --git a/opnsense/interfaces.go b/opnsense/interfaces.go index baa7ce9..3195345 100644 --- a/opnsense/interfaces.go +++ b/opnsense/interfaces.go @@ -63,23 +63,6 @@ type Interfaces struct { Interfaces []Interface } -// sliceIntToMapStringInt is a helper function to convert a slice of strings to a map of string:int -// The key of the map is the string value in the slice and -// the value of the map is the int value of the string. -func sliceIntToMapStringInt(strings []string, url EndpointPath) (map[string]int, *APICallError) { - ints := make(map[string]int) - - for _, str := range strings { - value, err := parseStringToInt(str, url) - if err != nil { - return nil, err - } - ints[str] = value - } - - return ints, nil -} - func (c *Client) FetchInterfaces() (Interfaces, *APICallError) { var resp interfaceResponse var data Interfaces diff --git a/opnsense/utils.go b/opnsense/utils.go index 6c60603..2b439c2 100644 --- a/opnsense/utils.go +++ b/opnsense/utils.go @@ -49,3 +49,23 @@ func parseStringToFloatWithReplace(value string, regex *regexp.Regexp, replacePa ) return -1.0 } + +// sliceIntToMapStringInt is a helper function to convert a slice of strings to a map of string:int +// The key of the map is the string value in the slice and +// the value of the map is the int value of the string. +// The endpoint is used to identify the EndpointPath that the caller used. +// so we can propagate in the *APICallError. +// Fails if any of the string values in the slice cannot be parsed to an int. +func sliceIntToMapStringInt(strings []string, url EndpointPath) (map[string]int, *APICallError) { + ints := make(map[string]int) + + for _, str := range strings { + value, err := parseStringToInt(str, url) + if err != nil { + return nil, err + } + ints[str] = value + } + + return ints, nil +} diff --git a/opnsense/utils_test.go b/opnsense/utils_test.go index 453da09..9e312a4 100644 --- a/opnsense/utils_test.go +++ b/opnsense/utils_test.go @@ -1,6 +1,7 @@ package opnsense import ( + "reflect" "regexp" "testing" @@ -68,3 +69,14 @@ func TestParsePercentage(t *testing.T) { }) } } + +func TestSliceIntToMapStringInt(t *testing.T) { + input := []string{"1", "2", "3"} + expected := map[string]int{"1": 1, "2": 2, "3": 3} + + result, _ := sliceIntToMapStringInt(input, "test") + + if !reflect.DeepEqual(result, expected) { + t.Errorf("Expected %v, got %v", expected, result) + } +}