github.com/googleapis/api-linter@v1.65.2/rules/aip0142/time_field_type.go (about)

     1  // Copyright 2019 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package aip0142
    16  
    17  import (
    18  	"strings"
    19  
    20  	"bitbucket.org/creachadair/stringset"
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/googleapis/api-linter/rules/internal/utils"
    24  	"github.com/jhump/protoreflect/desc"
    25  )
    26  
    27  var fieldType = &lint.FieldRule{
    28  	Name: lint.NewRuleName(142, "time-field-type"),
    29  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    30  		tokens := strings.Split(f.GetName(), "_")
    31  		suffix := tokens[len(tokens)-1]
    32  		typeName := utils.GetTypeName(f)
    33  		suffixes := stringset.New(
    34  			"date", "datetime", "ms", "msec", "msecs", "millis", "nanos", "ns",
    35  			"nsec", "nsecs", "sec", "secs", "seconds", "time", "timestamp", "us",
    36  			"usec", "usecs",
    37  		)
    38  		allowed := stringset.New(
    39  			"google.protobuf.Timestamp",
    40  			"google.type.Date",
    41  			"google.type.DateTime",
    42  			"google.type.TimeOfDay",
    43  		)
    44  		if suffixes.Contains(suffix) && !allowed.Contains(typeName) {
    45  			return []lint.Problem{{
    46  				Message:    "Fields representing timestamps should use `google.protobuf.Timestamp`.",
    47  				Suggestion: "google.protobuf.Timestamp",
    48  				Descriptor: f,
    49  				Location:   locations.FieldType(f),
    50  			}}
    51  		}
    52  		return nil
    53  	},
    54  }