PMM-12913 Migrate api endpoints to REST

.github/workflows/main.yml

@@ -81,22 +81,23 @@ jobs:
 
  - name: Run API linter
  env:
- COMMAND: 'bin/buf lint -v api'
- REDIRECT: "| bin/reviewdog -f=buf -reporter=github-pr-review -fail-on-error=true"
  REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.ROBOT_TOKEN || secrets.GITHUB_TOKEN }}
  run: |
- if out=$( ${{ env.COMMAND }} ); exit_code=$?; [ $exit_code -ne 0 ]; then
- ## buf uses exit code 100 for linter warnings
- if [ $exit_code != 100 ] || ${{ github.event.pull_request == null }}; then
- echo "$out"
- exit $exit_code
- else
- echo "$out" ${{ env.REDIRECT }}
- fi
- else
+ if out=$(bin/buf lint -v api); code="$?"; test "$code" -eq 0; then
  echo "$out"
+ exit 0
  fi
 
+ echo "API linter exited with code: $code"
+ echo "$out"
+ ## buf uses exit code 100 for linter warnings
+ if [ "$code" -ne 100 ] || ${{ github.event.pull_request == null }}; then
+ exit $code
+ fi
+
+ # One may need to suppress passing to reviewdog because of https://github.com/reviewdog/reviewdog/issues/1696
+ echo "$out" | bin/reviewdog -f=buf -reporter=github-pr-review -fail-on-error=true
+
  - name: Run code linters
  uses: reviewdog/action-golangci-lint@v2
  with:
@@ -110,21 +111,20 @@ jobs:
 
  - name: Run go-consistent
  env:
- COMMAND: 'bin/go-consistent -pedantic -exclude "tests" ./...'
- REDIRECT: "| bin/reviewdog -f=go-consistent -reporter=github-pr-review -fail-on-error=true"
  REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.ROBOT_TOKEN || secrets.GITHUB_TOKEN }}
  run: |
- if out=$( ${{ env.COMMAND }} ); exit_code=$?; [ $exit_code -ne 0 ]; then
- if [ $exit_code -gt 1 ] || ${{ github.event.pull_request == null }}; then
- echo "$out"
- exit $exit_code
- else
- echo "$out" ${{ env.REDIRECT }}
- fi
- else
+ if out=$(bin/go-consistent -pedantic -exclude "tests" ./...); exit_code=$?; [ $exit_code -eq 0 ]; then
  echo "$out"
+ exit 0
  fi
 
+ if [ $exit_code -gt 1 ] || ${{ github.event.pull_request == null }}; then
+ echo "$out"
+ exit $exit_code
+ fi
+
+ echo "$out" | bin/reviewdog -f=go-consistent -reporter=github-pr-review -fail-on-error=true
+
  - name: Test common API
  run: make test-common
 

.github/workflows/managed.yml

@@ -63,11 +63,7 @@ jobs:
 
  - name: Launch PMM Server (see docker-compose.yml)
  run: |
- # Note: launching the container with --wait fails for an unknown reason.
- # A temporary workaround is to run it manually. To be reverted once the issue is resolved.
- # make env-compose-up # the container workdir is /root/go/src/github.com/percona/pmm
- docker compose --profile pmm up -d
- sleep 100s
+ make env-compose-up # the container workdir is /root/go/src/github.com/percona/pmm
  docker logs pmm-server
 
  - name: Restore Go build cache

.golangci.yml

@@ -149,6 +149,7 @@ issues:
  - forcetypeassert # for tests' brevity sake
  - funlen # tests may be long
  - gocognit # triggered by subtests
+ - goconst # not critical for tests
  - gomnd # tests are full of magic numbers
  - ireturn # we have exceptions, so need to silence them in tests
  - lll # tests often require long lines

Makefile.include

@@ -48,7 +48,22 @@ gen-api: ## Generate PMM API
 
  bin/buf generate -v api
 
- for API in api/agentlocal/v1 api/server/v1 api/inventory/v1 api/management/v1 api/actions/v1 api/advisors/v1 api/alerting/v1 api/backup/v1 api/dump/v1 api/management/v1/azure api/role/v1 api/qan/v1 api/management/v1/agent api/management/v1/node api/management/v1/service api/platform/v1 api/user/v1; do \
+ SPECS="\
+ api/agentlocal/v1 \
+ api/server/v1 \
+ api/user/v1 \
+ api/inventory/v1 \
+ api/management/v1 \
+ api/management/v1/service \
+ api/actions/v1 \
+ api/advisors/v1 \
+ api/alerting/v1 \
+ api/backup/v1 \
+ api/dump/v1beta1 \
+ api/accesscontrol/v1beta1 \
+ api/qan/v1 \
+ api/platform/v1"; \
+ for API in $$SPECS; do \
  set -x ; \
  bin/swagger mixin $$API/json/header.json $$API/*.swagger.json --output=$$API/json/$$(basename $$API).json --keep-spec-order; \
  bin/swagger flatten --with-flatten=expand --with-flatten=remove-unused $$API/json/$$(basename $$API).json --output=$$API/json/$$(basename $$API).json ; \
@@ -78,7 +93,8 @@ gen-api: ## Generate PMM API
  api/backup/v1/json/v1.json \
  api/advisors/v1/json/v1.json \
  api/alerting/v1/json/v1.json \
- api/qan/v1/json/v1.json
+ api/dump/v1beta1/json/v1beta1.json \
+ api/qan/v1/json/v1.json
  bin/swagger validate api/swagger/swagger.json
 
  bin/swagger-order --output=api/swagger/swagger.json api/swagger/swagger.json
@@ -94,12 +110,8 @@ gen-api: ## Generate PMM API
  api/alerting/v1/json/v1.json \
  api/advisors/v1/json/v1.json \
  api/backup/v1/json/v1.json \
- api/dump/v1/json/v1.json \
- api/management/v1/azure/json/azure.json \
- api/role/v1/json/v1.json \
- api/management/v1/agent/json/agent.json \
- api/management/v1/node/json/node.json \
- api/management/v1/service/json/service.json \
+ api/dump/v1beta1/json/v1beta1.json \
+ api/accesscontrol/v1beta1/json/v1beta1.json \
  api/qan/v1/json/v1.json \
  api/platform/v1/json/v1.json
 
@@ -129,7 +141,21 @@ clean: clean_swagger ## Remove generated files
  find api -name '*.pb.gw.go' -print -delete
  find api -name '*.validate.go' -print -delete
 
- for API in api/agentlocal/v1 api/server/v1 api/inventory/v1 api/management/v1 api/actions/v1 api/alerting/v1 api/advisors/v1 api/backup/v1 api/dump/v1 api/role/v1 api/management/v1/agent api/management/v1/node api/management/v1/service api/qan/v1 api/platform/v1 ; do \
+ SPECS="\
+ api/agentlocal/v1 \
+ api/server/v1 \
+ api/user/v1 \
+ api/inventory/v1 \
+ api/management/v1 \
+ api/actions/v1 \
+ api/alerting/v1 \
+ api/advisors/v1 \
+ api/backup/v1 \
+ api/dump/v1beta1 \
+ api/accesscontrol/v1beta1 \
+ api/qan/v1 \
+ api/platform/v1"; \
+ for API in $$SPECS; do \
  rm -fr $$API/json/client $$API/json/models $$API/json/$$(basename $$API).json ; \
  done
  rm -f api/swagger/swagger.json api/swagger/swagger-dev.json
@@ -142,8 +168,8 @@ api-test: ## Run API tests on dev env.
 
 check: ## Run required checkers and linters
  bin/buf lint -v api
- LOG_LEVEL=error bin/golangci-lint run ; \
- bin/go-sumtype ./... ; \
+ LOG_LEVEL=error bin/golangci-lint run
+ bin/go-sumtype ./...
  bin/go-consistent -pedantic ./...
 
 check-license: ## Run license header checks against source files

admin/README.md

@@ -9,7 +9,7 @@ git, make, curl, go, gcc, pmm-server, pmm-agent
 
 ## Local setup
 ### To run pmm-admin commands
-- Run [pmm-server docker container](https://hub.docker.com/r/percona/pmm-server) or [pmm-managed](https://github.com/percona/pmm-managed). 
+- Run [pmm-server docker container](https://hub.docker.com/r/percona/pmm-server) or [pmm-managed](https://github.com/percona/pmm/tree/main/managed). 
 - Run pmm-agent `cd ../agent`.
 - Run pmm-admin commands.
  ```shell script
@@ -18,8 +18,9 @@ git, make, curl, go, gcc, pmm-server, pmm-agent
 
 You should see something like this
  ```shell script
-Agent ID: /agent_id/fcbe3cb4-a95a-43f4-aef5-c3494caa5132
-Node ID : /node_id/77be6b4d-a1d9-4687-8fae-7acbaee7db47
+Agent ID : /agent_id/fcbe3cb4-a95a-43f4-aef5-c3494caa5132
+Node ID : /node_id/77be6b4d-a1d9-4687-8fae-7acbaee7db47
+Node name: mysql-server-test-1
 
 PMM Server:
  URL : https://127.0.0.1:443/
@@ -31,10 +32,10 @@ PMM-agent:
  Latency : 211.026µs
 
 Agents:
- /agent_id/3329a405-8a5d-4414-9890-b6ae4209e0cc NODE_EXPORTER RUNNING
+ /agent_id/3329a405-8a5d-4414-9890-b6ae4209e0cc NODE_EXPORTER RUNNING 40001
 ```
 It means that everything works.
 
 ## Testing
-pmm-admin doesn't require setting-up environment. 
+pmm-admin doesn't require setting-up an environment. 
 Run `make test` to run tests. 

admin/commands/annotation.go

@@ -17,6 +17,7 @@ package commands
 import (
  "strings"
 
+ "github.com/AlekSi/pointer"
  "github.com/pkg/errors"
 
  "github.com/percona/pmm/admin/agentlocal"
@@ -77,9 +78,7 @@ func (cmd *AnnotationCommand) getCurrentNode() (*nodes.GetNodeOKBody, error) {
  }
 
  params := &nodes.GetNodeParams{
- Body: nodes.GetNodeBody{
- NodeID: status.NodeID,
- },
+ NodeID: status.NodeID,
  Context: Ctx,
  }
 
@@ -109,9 +108,7 @@ func (cmd *AnnotationCommand) getCurrentNodeAllServices() ([]string, error) {
  }
 
  params := &services.ListServicesParams{
- Body: services.ListServicesBody{
- NodeID: status.NodeID,
- },
+ NodeID: pointer.ToString(status.NodeID),
  Context: Ctx,
  }
 

admin/commands/base_test.go

@@ -86,7 +86,7 @@ func TestCredentials(t *testing.T) {
  // Test reading is OK
  t.Parallel()
  creds, _ := ReadFromSource(credSource)
- assert.Equal(t, creds.Username, "testuser")
+ assert.Equal(t, "testuser", creds.Username)
  })
 
  t.Run("Executing", func(t *testing.T) {

admin/commands/inventory/list_agents.go

@@ -108,16 +108,12 @@ func (cmd *ListAgentsCommand) RunCmd() (commands.Result, error) {
  return nil, err
  }
 
- filters := agents.ListAgentsBody{
- PMMAgentID: cmd.PMMAgentID,
- ServiceID: cmd.ServiceID,
- NodeID: cmd.NodeID,
- AgentType: agentType,
- }
-
  params := &agents.ListAgentsParams{
- Body: filters,
- Context: commands.Ctx,
+ PMMAgentID: pointer.ToString(cmd.PMMAgentID),
+ ServiceID: pointer.ToString(cmd.ServiceID),
+ NodeID: pointer.ToString(cmd.NodeID),
+ AgentType: agentType,
+ Context: commands.Ctx,
  }
  agentsRes, err := client.Default.AgentsService.ListAgents(params)
  if err != nil {

admin/commands/inventory/list_nodes.go

@@ -71,8 +71,8 @@ func (cmd *ListNodesCommand) RunCmd() (commands.Result, error) {
  }
 
  params := &nodes.ListNodesParams{
- Body: nodes.ListNodesBody{NodeType: nodeType},
- Context: commands.Ctx,
+ NodeType: nodeType,
+ Context:  commands.Ctx,
  }
  result, err := client.Default.NodesService.ListNodes(params)
  if err != nil {

admin/commands/inventory/list_services.go

@@ -19,6 +19,8 @@ import (
  "net"
  "strconv"
 
+ "github.com/AlekSi/pointer"
+
  "github.com/percona/pmm/admin/commands"
  "github.com/percona/pmm/api/inventory/v1/json/client"
  services "github.com/percona/pmm/api/inventory/v1/json/client/services_service"
@@ -85,15 +87,11 @@ func (cmd *ListServicesCommand) RunCmd() (commands.Result, error) {
  return nil, err
  }
 
- filters := services.ListServicesBody{
- ExternalGroup: cmd.ExternalGroup,
- NodeID: cmd.NodeID,
- ServiceType: serviceType,
- }
-
  params := &services.ListServicesParams{
- Body: filters,
- Context: commands.Ctx,
+ NodeID: pointer.ToString(cmd.NodeID),
+ ExternalGroup: pointer.ToString(cmd.ExternalGroup),
+ ServiceType: serviceType,
+ Context: commands.Ctx,
  }
  result, err := client.Default.ServicesService.ListServices(params)
  if err != nil {

admin/commands/inventory/remove_agent.go

@@ -15,6 +15,8 @@
 package inventory
 
 import (
+ "github.com/AlekSi/pointer"
+
  "github.com/percona/pmm/admin/commands"
  "github.com/percona/pmm/api/inventory/v1/json/client"
  agents "github.com/percona/pmm/api/inventory/v1/json/client/agents_service"
@@ -41,10 +43,8 @@ type RemoveAgentCommand struct {
 // RunCmd executes the RemoveAgentCommand and returns the result.
 func (cmd *RemoveAgentCommand) RunCmd() (commands.Result, error) {
  params := &agents.RemoveAgentParams{
- Body: agents.RemoveAgentBody{
- AgentID: cmd.AgentID,
- Force: cmd.Force,
- },
+ AgentID: cmd.AgentID,
+ Force: pointer.ToBool(cmd.Force),
  Context: commands.Ctx,
  }
  _, err := client.Default.AgentsService.RemoveAgent(params)

admin/commands/inventory/remove_node.go

@@ -15,6 +15,8 @@
 package inventory
 
 import (
+ "github.com/AlekSi/pointer"
+
  "github.com/percona/pmm/admin/commands"
  "github.com/percona/pmm/api/inventory/v1/json/client"
  nodes "github.com/percona/pmm/api/inventory/v1/json/client/nodes_service"
@@ -41,10 +43,8 @@ type RemoveNodeCommand struct {
 // RunCmd runs the command for RemoveNodeCommand.
 func (cmd *RemoveNodeCommand) RunCmd() (commands.Result, error) {
  params := &nodes.RemoveNodeParams{
- Body: nodes.RemoveNodeBody{
- NodeID: cmd.NodeID,
- Force: cmd.Force,
- },
+ NodeID: cmd.NodeID,
+ Force: pointer.ToBool(cmd.Force),
  Context: commands.Ctx,
  }
  _, err := client.Default.NodesService.RemoveNode(params)

admin/commands/inventory/remove_service.go

@@ -15,6 +15,8 @@
 package inventory
 
 import (
+ "github.com/AlekSi/pointer"
+
  "github.com/percona/pmm/admin/commands"
  "github.com/percona/pmm/api/inventory/v1/json/client"
  services "github.com/percona/pmm/api/inventory/v1/json/client/services_service"
@@ -41,11 +43,9 @@ type RemoveServiceCommand struct {
 // RunCmd executes the RemoveServiceCommand and returns the result.
 func (cmd *RemoveServiceCommand) RunCmd() (commands.Result, error) {
  params := &services.RemoveServiceParams{
- Body: services.RemoveServiceBody{
- ServiceID: cmd.ServiceID,
- Force: cmd.Force,
- },
- Context: commands.Ctx,
+ ServiceID: cmd.ServiceID,
+ Force: pointer.ToBool(cmd.Force),
+ Context: commands.Ctx,
  }
  _, err := client.Default.ServicesService.RemoveService(params)
  if err != nil {

admin/commands/list.go

@@ -134,9 +134,7 @@ func (cmd *ListCommand) RunCmd() (Result, error) {
  }
 
  servicesRes, err := client.Default.ServicesService.ListServices(&services.ListServicesParams{
- Body: services.ListServicesBody{
- NodeID: cmd.NodeID,
- },
+ NodeID: pointer.ToString(cmd.NodeID),
  Context: Ctx,
  })
  if err != nil {