cost-model/vendor/github.com/googleapis/gnostic/plugins/gnostic-analyze/main.go

// Copyright 2017 Google Inc. All Rights Reserved.
//
// 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.

// gnostic_analyze is a tool for analyzing OpenAPI descriptions.
//
// It scans an API description and evaluates properties
// that influence the ease and quality of code generation.
//  - The number of HTTP operations of each method (GET, POST, etc).
//  - The number of HTTP operations with no OperationId value.
//  - The parameter types used and their frequencies.
//  - The response types used and their frequencies.
//  - The types used in definition objects and arrays and their frequencies.
// Results are returned in a JSON structure.
package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"os"
	"path"
	"strings"

	"github.com/golang/protobuf/proto"
	"github.com/googleapis/gnostic/plugins/gnostic-analyze/statistics"

	openapi "github.com/googleapis/gnostic/OpenAPIv2"
	plugins "github.com/googleapis/gnostic/plugins"
)

// Record an error, then serialize and return a response.
func sendAndExitIfError(err error, response *plugins.Response) {
	if err != nil {
		response.Errors = append(response.Errors, err.Error())
		sendAndExit(response)
	}
}

// Serialize and return a response.
func sendAndExit(response *plugins.Response) {
	responseBytes, _ := proto.Marshal(response)
	os.Stdout.Write(responseBytes)
	os.Exit(0)
}

func main() {
	// Initialize the response.
	response := &plugins.Response{}

	// Read the request.
	data, err := ioutil.ReadAll(os.Stdin)
	sendAndExitIfError(err, response)
	if len(data) == 0 {
		sendAndExitIfError(fmt.Errorf("no input data"), response)
	}

	// Unmarshal the request.
	request := &plugins.Request{}
	err = proto.Unmarshal(data, request)
	sendAndExitIfError(err, response)

	// Verify that the passed-in description is supported.
	wrapper := request.Wrapper
	if wrapper.Version != "v2" {
		err = fmt.Errorf("%s requires an OpenAPI v2 description.",
			os.Args[0])
		sendAndExitIfError(err, response)
	}

	// Unmarshal the description.
	document := &openapi.Document{}
	err = proto.Unmarshal(wrapper.Value, document)
	sendAndExitIfError(err, response)

	// Analyze the API document.
	stats := statistics.NewDocumentStatistics(wrapper.Name, document)

	// Return the analysis results with an appropriate filename.
	// Results are in files named "summary.json" in the same relative
	// locations as the description source files.
	file := &plugins.File{}
	file.Name = strings.Replace(stats.Name, path.Base(stats.Name), "summary.json", -1)
	file.Data, err = json.MarshalIndent(stats, "", "  ")
	file.Data = append(file.Data, []byte("\n")...)
	sendAndExitIfError(err, response)
	response.Files = append(response.Files, file)

	// Send the final results. Success!
	sendAndExit(response)
}