Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 3.39 KB

DEVELOPING.md

File metadata and controls

103 lines (75 loc) · 3.39 KB
Raw

Start Developing

This plugin is a data source backend plugin. It uses Grafana Plugin Tools and consists of both backend and frontend components.

Prerequisites

For this project to work you need Node.js and Go installed.

As with other Grafana data source plugin projects, yarn is used for managing and building the frontend and Mage for the backend.

Additionally, Docker is used to simplify plugin development and integration testing.

Getting started

Clone and build

Clone this repository into your local environment

git clone https://github.com/d-velop/grafana-odata-datasource.git

Backend

Backend code is located in the pkg folder

Build backend plugin binaries by running the mage build (-v stands for verbose output)

mage -v

Frontend

Frontend code is located in the src folder

Install dependencies

yarn install

Build plugin in development mode

yarn dev

or build plugin in production mode

yarn build

Using the OData test-server

If you don't have a full-fledged OData server at hand, you will find a test server based on Express and on the Core Data Services (CDS) of the SAP Cloud Application Programming Model in the test-server directory.

It can be started by using the command

cd test-server
yarn start

In addition, the test server is automatically built and started using Docker Compose (see below).

For more information see test-server/README.md.

Try and test using Docker Compose

The project includes a docker-compose.yml file. With this, Grafana can be started quickly for development purposes. The local project directory is automatically mounted to the Grafana plugin directory.

Additionally, to keep development uncomplicated, anonymous authorization is enabled in Grafana. The project also comes with predefined data source configurations (using the aforementioned test-server) and test dashboards that allow changes to be tried out and tested directly. See folder provisioning for details.

To start, simply run the following command

yarn server

in the projects root directory. Afterwards you can open http://localhost:3000 in your browser and begin using Grafana with the preconfigured OData Data Source.

Note: If you want to access a locally running OData Service Root make sure you use the correct hostname. You can use docker's special DNS name host.docker.internal which resolves to the internal IP address used by the docker host.

Testing

Run all backend test by executing the following command:

mage test

Coverage

To evaluate the backend test coverage execute the following command:

mage coverage

The results are written to a backend.html file located in the ./coverage folder.

Update create-plugin versions

To update the plugin to use a newer version of the create-plugin tool, follow the instructions here: https://grafana.com/developers/plugin-tools/migration-guides/update-create-plugin-versions.

The source code of the create-plugin tool can be found here: https://github.com/grafana/plugin-tools/tree/main/packages/create-plugin.