diff --git a/.github/workflows/build-plugin/LICENSE b/.github/workflows/build-plugin/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/.github/workflows/build-plugin/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 [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. diff --git a/.github/workflows/build-plugin/action.yml b/.github/workflows/build-plugin/action.yml new file mode 100644 index 0000000..2c2f99f --- /dev/null +++ b/.github/workflows/build-plugin/action.yml @@ -0,0 +1,169 @@ +name: "Grafana Build Plugin" +description: "Builds a Grafana plugin" + +outputs: + archive: + description: "The path to the plugin archive (zip)." + value: ${{ steps.metadata.outputs.archive }} + archive-sha1sum: + description: "The path to the plugin archive sha1sum." + value: ${{ steps.metadata.outputs.archive-sha1sum }} + archive-url: + description: "The URL to the plugin archive." + value: ${{ steps.metadata.outputs.archive-url }} + archive-sha1sum-url: + description: "The URL to the plugin archive sha1sum." + value: ${{ steps.metadata.outputs.archive-sha1sum-url }} + +inputs: + token: + description: "Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`." + required: false + default: "${{ github.token }}" + policy_token: + description: "Grafana access policy token. https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token" + required: false + default: "" + grafana_token: + description: "[deprecated] Grafana API Key to sign a plugin. Prefer `policy_token`." + required: false + default: "" + go-version: + description: "Version of go" + required: false + default: "1.22" + node-version: + description: "Version of node" + required: false + default: "20" + working-directory: + description: "The working directory where the plugin is located" + required: false + default: "." + +runs: + using: "composite" + steps: + - uses: actions/setup-node@v4 + with: + node-version: "${{ inputs.node-version }}" + + - name: Setup Go environment + uses: actions/setup-go@v5 + with: + go-version: "${{ inputs.go-version }}" + + - name: Install dependencies + run: ${{ github.action_path }}/pm.sh install + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Build and test frontend + run: ${{ github.action_path }}/pm.sh build + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Check for backend + id: check-for-backend + run: | + if [ -f "Magefile.go" ] + then + echo "has-backend=true" >> $GITHUB_OUTPUT + fi + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Test backend + if: steps.check-for-backend.outputs.has-backend == 'true' + uses: magefile/mage-action@v3 + with: + version: latest + args: coverage + workdir: ${{ inputs.working-directory }} + + - name: Build backend + if: steps.check-for-backend.outputs.has-backend == 'true' + uses: magefile/mage-action@v3 + with: + version: latest + args: buildAll + workdir: ${{ inputs.working-directory }} + + - name: Warn missing Grafana access policy token + run: | + echo Please generate a Grafana access policy token: https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token + echo Once done please follow the instructions found here: https://github.com/${{github.repository}}/blob/main/README.md#using-github-actions-release-workflow + if: ${{ inputs.policy_token == '' }} + shell: bash + + - name: Sign plugin + run: ${{ github.action_path }}/pm.sh sign + shell: bash + env: + GRAFANA_ACCESS_POLICY_TOKEN: ${{ inputs.policy_token }} + GRAFANA_API_KEY: ${{ inputs.grafana_token }} + if: ${{ inputs.policy_token != '' }} + working-directory: ${{ inputs.working-directory }} + + - name: Get plugin metadata + id: metadata + run: | + sudo apt-get install jq + + export GRAFANA_PLUGIN_ID=$(cat dist/plugin.json | jq -r .id) + export GRAFANA_PLUGIN_VERSION=$(cat dist/plugin.json | jq -r .info.version) + export GRAFANA_PLUGIN_TYPE=$(cat dist/plugin.json | jq -r .type) + export GRAFANA_PLUGIN_ARTIFACT=${GRAFANA_PLUGIN_ID}-${GRAFANA_PLUGIN_VERSION}.zip + export GRAFANA_PLUGIN_ARTIFACT_SHA1SUM=${GRAFANA_PLUGIN_ARTIFACT}.sha1 + + echo "plugin-id=${GRAFANA_PLUGIN_ID}" >> $GITHUB_OUTPUT + echo "plugin-version=${GRAFANA_PLUGIN_VERSION}" >> $GITHUB_OUTPUT + echo "plugin-type=${GRAFANA_PLUGIN_TYPE}" >> $GITHUB_OUTPUT + echo "archive=${GRAFANA_PLUGIN_ARTIFACT}" >> $GITHUB_OUTPUT + echo "archive-sha1sum=${GRAFANA_PLUGIN_ARTIFACT_SHA1SUM}" >> $GITHUB_OUTPUT + echo "archive-url=https://github.com/${{ github.repository }}/releases/download/v${{ steps.metadata.outputs.plugin-version }}/${{ steps.metadata.outputs.archive }}" + echo "archive-sha1sum-url=(https://github.com/${{ github.repository }}/releases/download/v${{ steps.metadata.outputs.plugin-version }}/${{ steps.metadata.outputs.archive-sha1sum }}" + echo "github-tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Read changelog + id: changelog + run: | + awk '/^## / {s++} s == 1 {print}' CHANGELOG.md > release_notes.md + echo "path=release_notes.md" >> $GITHUB_OUTPUT + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Check package version + run: if [ "v${{ steps.metadata.outputs.plugin-version }}" != "${{ steps.metadata.outputs.github-tag }}" ]; then printf "\033[0;31mPlugin version doesn't match tag name. The tag should be v${{ steps.metadata.outputs.plugin-version }} \033[0m\n"; exit 1; fi + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Package plugin + id: package-plugin + run: | + mv dist ${{ steps.metadata.outputs.plugin-id }} + zip ${{ steps.metadata.outputs.archive }} ${{ steps.metadata.outputs.plugin-id }} -r + sha1sum ${{ steps.metadata.outputs.archive }} | cut -f1 -d' ' > ${{ steps.metadata.outputs.archive-sha1sum }} + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Validate plugin + run: | + git clone https://github.com/grafana/plugin-validator + pushd ./plugin-validator/pkg/cmd/plugincheck2 + go install + popd + plugincheck2 -config ./plugin-validator/config/default.yaml ${{ steps.metadata.outputs.archive }} + shell: bash + working-directory: ${{ inputs.working-directory }} + + - name: Create Github release + uses: softprops/action-gh-release@v2 + with: + generate_release_notes: true + token: ${{ inputs.token }} + files: | + ${{ inputs.working-directory }}/${{ steps.metadata.outputs.archive }} + ${{ inputs.working-directory }}/${{ steps.metadata.outputs.archive-sha1sum }} diff --git a/.github/workflows/build-plugin/pm.sh b/.github/workflows/build-plugin/pm.sh new file mode 100755 index 0000000..623902d --- /dev/null +++ b/.github/workflows/build-plugin/pm.sh @@ -0,0 +1,38 @@ +#!/bin/bash + +# Check if command argument is provided +if [ "$1" = "" ]; then + echo "Please provide a command to run." + exit 1 +fi + +install_pnpm_if_not_present() { + if ! command -v pnpm &> /dev/null + then + echo "pnpm could not be found, installing..." + npm install -g pnpm + fi +} + +corepack enable + +# Detect the package manager +if [ -f yarn.lock ]; then + pm="yarn" +elif [ -f pnpm-lock.yaml ]; then + install_pnpm_if_not_present + pm="pnpm" +elif [ -f package-lock.json ]; then + pm="npm" +else + echo "No recognized package manager found in this project." + exit 1 +fi + +# Run the provided command with the detected package manager +echo "Running '$1' with $pm..." +if [ "$1" = "install" ]; then + "$pm" install +else + "$pm" run "$1" +fi diff --git a/.github/workflows/release-plugin.yml b/.github/workflows/release-plugin.yml new file mode 100644 index 0000000..4af0911 --- /dev/null +++ b/.github/workflows/release-plugin.yml @@ -0,0 +1,53 @@ +name: Release +on: + push: + tags: + - "v*" # Run workflow on version tags, e.g. v1.0.0. + +permissions: + contents: write + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + - name: Build Plugin + id: build_plugin + uses: ./.github/workflows/build-plugin + with: + policy-token: ${{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }} + working-directory: grafana-aitraining-app + + - name: Get version from tag + id: get_version + run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT + + - name: Publish new plugin version on grafana.com + env: + GCOM_TOKEN: ${{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }} + VERSION: ${{ steps.get_version.outputs.VERSION }} + ARCHIVE_URL: ${{ steps.build_plugin.outputs.archive-url }} + ARCHIVE_SHA1SUM_URL: ${{ steps.build_plugin.outputs.archive-sha1sum-url }} + run: | + echo "Publish new plugin version on grafana.com:" + echo "Plugin version: ${VERSION}" + + # Download the SHA1 sum + SHA1=$(cat ${{ steps.build_plugin.outputs.archive-sha1sum }}) + result=$(curl -H "Authorization: Bearer $GCOM_TOKEN" \ + -H "Content-Type: application/json" \ + https://grafana.com/api/plugins -d @- << EOF + { + "url": "https://github.com/${{ github.repository }}/tree/${{ github.ref_name }}", + "download": { + "any": { + "url": "${ARCHIVE_URL}", + "sha1": "${SHA1}" + } + } + } + EOF + ) + echo "Result: $result" diff --git a/grafana-aitraining-app/pkg/plugin/resources_test.go b/grafana-aitraining-app/pkg/plugin/resources_test.go index c5205be..5ac53ff 100644 --- a/grafana-aitraining-app/pkg/plugin/resources_test.go +++ b/grafana-aitraining-app/pkg/plugin/resources_test.go @@ -3,9 +3,10 @@ package plugin import ( "bytes" "context" - "github.com/grafana/grafana-plugin-sdk-go/backend" "net/http" "testing" + + "github.com/grafana/grafana-plugin-sdk-go/backend" ) // mockCallResourceResponseSender implements backend.CallResourceResponseSender @@ -24,7 +25,10 @@ func (s *mockCallResourceResponseSender) Send(response *backend.CallResourceResp // This ensures the httpadapter for CallResource works correctly. func TestCallResource(t *testing.T) { // Initialize app - inst, err := NewApp(context.Background(), backend.AppInstanceSettings{}) + testJSON := []byte(`{"metadataUrl": "http://example.com"}`) + inst, err := NewApp(context.Background(), backend.AppInstanceSettings{ + JSONData: testJSON, + }) if err != nil { t.Fatalf("new app: %s", err) }