pkg/api/v1/server.go

/*
Copyright 2021 The TestGrid 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.
*/

// Package v1 (api/v1) is the first versioned implementation of the API
package v1

import (
	"time"

	apipb "github.com/GoogleCloudPlatform/testgrid/pb/api/v1"
	"github.com/GoogleCloudPlatform/testgrid/util/gcs"
	"github.com/go-chi/chi"
)

// Server contains the necessary settings and i/o objects needed to serve this api
type Server struct {
	Client                   gcs.ConditionalClient
	DefaultBucket            string
	TabPathPrefix            string
	SummaryPathPrefix        string
	AccessControlAllowOrigin string
	Timeout                  time.Duration
	defaultCache             *cachedConfig
}

// Ensure the server implementation conforms to the API
var _ apipb.TestGridDataServer = (*Server)(nil)

// Route applies all the v1 API functions provided by the Server to the Router given.
// If the router is nil, a new one is instantiated.
func Route(r *chi.Mux, s Server) *chi.Mux {
	if r == nil {
		r = chi.NewRouter()
	}
	r.Get("/dashboard-groups", s.ListDashboardGroupHTTP)
	r.Get("/dashboard-groups/{dashboard-group}", s.GetDashboardGroupHTTP)
	r.Get("/dashboards", s.ListDashboardsHTTP)
	r.Get("/dashboards/{dashboard}/tabs", s.ListDashboardTabsHTTP)
	r.Get("/dashboards/{dashboard}", s.GetDashboardHTTP)

	r.Get("/dashboards/{dashboard}/tabs/{tab}/headers", s.ListHeadersHTTP)
	r.Get("/dashboards/{dashboard}/tabs/{tab}/rows", s.ListRowsHTTP)

	r.Get("/dashboards/{dashboard}/tab-summaries", s.ListTabSummariesHTTP)
	r.Get("/dashboards/{dashboard}/tab-summaries/{tab}", s.GetTabSummaryHTTP)

	r.Get("/dashboard-groups/{dashboard-group}/dashboard-summaries", s.ListDashboardSummariesHTTP)
	r.Get("/dashboards/{dashboard}/summary", s.GetDashboardSummaryHTTP)
	return r
}