protovalidate触っていく

mkdir proto
cd proto
buf mod init

mkdir -p example/hello/v1
touch example/hello/v1/hello.proto

tree .
.
├── buf.yaml
└── example
    └── hello
        └── v1
            └── hello.proto

version: v1
+deps:
+  - buf.build/bufbuild/protovalidate
breaking:
  use:
    - FILE
lint:
  use:
    - DEFAULT

buf mod update
tree .
.
├── buf.lock
├── buf.yaml
└── example
    └── hello
        └── v1
            └── hello.proto

syntax = "proto3";

package example.hello.v1;

import "buf/validate/validate.proto";

message Hello { string hello = 1 [ (buf.validate.field).string.min_len = 1 ]; }

  "protoc": {
    "options": ["-I=~/.cache/buf/v1/module/data/buf.build"]
  }

go mod init protovalidate-demo
touch main.go

go get github.com/bufbuild/protovalidate-go

version: v2
managed:
  enabled: true
  override:
    - file_option: go_package_prefix
      value: protovalidate-demo/gen
  disable:
    - module: buf.build/bufbuild/protovalidate
      file_option: go_package_prefix
plugins:
  - remote: buf.build/protocolbuffers/go:v1.34.1
    out: gen
    opt: paths=source_relative

buf generate proto

package main

import (
	"fmt"
	hellov1 "protovalidate-demo/gen/hello/v1"

	"github.com/bufbuild/protovalidate-go"
)

func main() {
	msg := &hellov1.Hello{
		Hello: "",
	}

	v, err := protovalidate.New()
	if err != nil {
		panic(err)
	}

	if err = v.Validate(msg); err != nil {
		fmt.Println("validation failed:", err)
	} else {
		fmt.Println("validation succeeded")
	}
}

go run main.go
validation failed: validation error:
 - hello: value length must be at least 1 characters [string.min_len]

message Example{
  option (buf.validate.message).cel = {
    id: "message_expression_nested",
    message: "a must be greater than b",
    expression: "this.a > this.b"
  };

  int32 a = 1;
  int32 b = 2;
}

message Product {
  double price = 1 [(buf.validate.field).cel = {
    id: "product.price_range",
    message: "Price must be between 0 and 1000",
    expression: "this >= 0 && this <= 1000",
  }];
}

message DisabledExample {
  option (buf.validate.message).disabled = true;
  // このバリデーションは無効化される
  string val = 1 [ (buf.validate.field).string.min_len = 1 ];
}

message OneofExample {
  oneof union {
    option (buf.validate.oneof).required = true;
    string val1 = 1;
    string val2 = 2;
  }
}

validation failed: validation error:
 - union: exactly one field is required in oneof [required]

message Hello { string hello = 1 [ (buf.validate.field).string.min_len = 1 ]; }

  // const_value = "const" ok
  // const_value = "const1" NG
  string const_value = 1 [ (buf.validate.field).string.const = "const" ];

  // len_value = "Hello!!" NG
 // len_value = "Hello" OK
  string len_value = 2 [ (buf.validate.field).string.len = 5 ];

  // min_len_value = "Hi" NG
  string min_len_value = 3 [ (buf.validate.field).string.min_len = 5 ];

  // max_len_value = "Hello!!" NG
  string max_len_value = 4 [ (buf.validate.field).string.max_len = 5 ];

  // 2バイトの文字列である必要がある
  // len_bytes_value = "ab" OK
  // len_bytes_value = "abc" NG
  string len_bytes_value = 5 [ (buf.validate.field).string.len_bytes = 2 ];

  // min_bytes_value = "a" NG
  string min_bytes_value = 6 [ (buf.validate.field).string.min_bytes = 2 ];

  // max_bytes_value = "abc" NG
  string max_bytes_value = 7 [ (buf.validate.field).string.max_bytes = 2 ];

  // pattern_value = "hi, world" NG
  // pattern_value = "hello, world" OK
  string pattern_value = 8
      [ (buf.validate.field).string.pattern = "^hello, .*$" ];

  // prefix_value = "Hello, World" OK
  string prefix_value = 9 [ (buf.validate.field).string.prefix = "Hello" ];

  // suffix_value = "Hello, World" OK
  // suffix_value = "Hello, Japan" NG
  string suffix_value = 10 [ (buf.validate.field).string.suffix = "World" ];

  // contains_value = "apple, banana, orange" OK
  // contains_value = "apple, orange" NG
  string contains_value = 11
      [ (buf.validate.field).string.contains = "banana" ];

  // not_contains_value = "apple, banana, orange" NG
  // not_contains_value = "apple, orange" OK
  string not_contains_value = 12
      [ (buf.validate.field).string.not_contains = "banana" ];

  // in_value = "Go" OK
  // in_value = "Rust" NG
  string in_value = 13 [
    (buf.validate.field).string.in = "Java",
    (buf.validate.field).string.in = "Kotlin",
    (buf.validate.field).string.in = "Go"
  ];

  // not_in_value = "Go" NG
  // not_in_value = "Rust" OK
  string not_in_value = 14 [
    (buf.validate.field).string.not_in = "Java",
    (buf.validate.field).string.not_in = "Kotlin",
    (buf.validate.field).string.not_in = "Go"
  ];

  // protovalidate@example.com OK
  // protovalidate.example.com NG
  string email_value = 15 [ (buf.validate.field).string.email = true ];

  // 127.0.0.1 NG
  // https://example.com NG
  // example.com OK
  string hostname_value = 16 [ (buf.validate.field).string.hostname = true ];

  // 127.0.0.1 OK
  // ::192.0.2.33 OK
  // 2001:0db8:85a3:0000:0000:8a2e:0370:7334 OK
  // 255.255.255.256 NG
  string ip_value = 17 [ (buf.validate.field).string.ip = true ];

  // 127.0.0.1 OK
  // 2001:0db8:85a3:0000:0000:8a2e:0370:7334 NG
  string ipv4_value = 18 [ (buf.validate.field).string.ipv4 = true ];

  // 127.0.0.1 NG
  // 2001:0db8:85a3:0000:0000:8a2e:0370:7334 OK
  string ipv6_value = 19 [ (buf.validate.field).string.ipv6 = true ];

  // https://example.com OK
  // example.com NG
  string uri_value = 20 [ (buf.validate.field).string.uri = true ];

  // ./example.com OK
  string uri_ref_value = 21 [ (buf.validate.field).string.uri_ref = true ];

  // 127.0.0.1 OK
  // example.com OK
  string address_value = 22 [ (buf.validate.field).string.address = true ];

  // 550e8400-e29b-41d4-a716-446655440000 OK
  string uuid_value = 23 [ (buf.validate.field).string.uuid = true ];

  // 550e8400e29b41d4a716446655440000 OK
  string tuuid_value = 24 [ (buf.validate.field).string.tuuid = true ];

  // 255.255.255.0/24 OK
  // 255.255.255.0 NG
  string ip_with_preifxlen_value = 25
      [ (buf.validate.field).string.ip_with_prefixlen = true ];

  // 255.255.255.0/24 OK
  // 255.255.255.0 NG
  string ipv4_with_preifxlen_value = 26
      [ (buf.validate.field).string.ipv4_with_prefixlen = true ];

  // 2001:0db8:85a3:0000:0000:8a2e:0370:7334/24 OK
  // 2001:0db8:85a3:0000:0000:8a2e:0370:7334 NG
  string ipv6_with_preifxlen_value = 27
      [ (buf.validate.field).string.ipv6_with_prefixlen = true ];

  // 127.0.0.0/16 OK
  // 127.0.0.1/16 NG
  string ip_prefix_value = 28 [ (buf.validate.field).string.ip_prefix = true ];

  // 127.0.0.0/16 OK
  // 127.0.0.1/16 NG
  string ip4_prefix_value = 29
      [ (buf.validate.field).string.ipv4_prefix = true ];

  // 2001:db8::/48 OK
  // 2001:db8::1/48 NG
  string ip6_prefix_value = 30
      [ (buf.validate.field).string.ipv6_prefix = true ];

  // 127.0.0.1:8080 OK
  // 127.0.0.1 NG
  // example.com:8080 OK
  // example.com NG
  // [::1]:1234 OK
  string host_and_port_value = 31
      [ (buf.validate.field).string.host_and_port = true ];

enum KnownRegex {
    KNOWN_REGEX_UNSPECIFIED = 0,
    // RFC 7230で定義されているHTTPヘッダー名とその値の形式
    KNOWN_REGEX_HTTP_HEADER_NAME = 1,
    KNOWN_REGEX_HTTP_HEADER_VALUE = 2
}

  // KnownRegex enumを指定する
  // KNOWN_REGEX_HTTP_HEADER_NAME HTTPヘッダー名
  // KNOWN_REGEX_HTTP_HEADER_VALUE HTTPヘッダー値
  //
  // Content-Type OK
  // Content Type OK (strict = fasle)
  // Content Type NG (strict = true)
  string well_kown_regex_value = 32 [
    (buf.validate.field).string.well_known_regex = KNOWN_REGEX_HTTP_HEADER_NAME,
    (buf.validate.field).string.strict = false
  ];

message BoolValidationExample {
    // true_value = true OK
    // true_value = false NG
  bool true_value = 1 [ (buf.validate.field).bool.const = true ];
    // false_value = true NG
    // false_value = false OK
  bool false_value = 2 [ (buf.validate.field).bool.const = false ];
}

  // 1234 OK
  // 123 NG
  bytes const_value = 1
      [ (buf.validate.field).bytes.const = "\x01\x02\x03\x04" ];

  // 1234 OK
  // 123 NG
  bytes len_value = 2 [ (buf.validate.field).bytes.len = 4 ];
  // 123 OK
  // 1 NG
  bytes min_len_value = 3 [ (buf.validate.field).bytes.min_len = 2 ];
  // 12 OK
  // 123 NG
  bytes max_len_value = 4 [ (buf.validate.field).bytes.max_len = 2 ];

  // 0x61 (a) OK
  // 0xe3, 0x81, 0x82 (あ) NG
  bytes pattern_value = 5
      [ (buf.validate.field).bytes.pattern = "^[a-zA-Z0-9]+$" ];

  // 0x01, 0x02, 0x03 OK
  // 0x01, 0x03, 0x02NG
  bytes prefix_value = 6 [ (buf.validate.field).bytes.prefix = "\x01\x02" ];
  // 0x01, 0x02, 0x03 OK
  // 0x02, 0x01, 0x03 NG
  bytes suffix_value = 7 [ (buf.validate.field).bytes.suffix = "\x02\x03" ];

  // 0x01, 0x02, 0x03 OK
  // 0x01, 0x03 NG
  bytes contains_value = 8 [ (buf.validate.field).bytes.contains = "\x02" ];

  // 0x02, 0x03 OK
  // 0x01, 0x02, 0x03 NG
  bytes in_value = 9 [
    (buf.validate.field).bytes.in = "\x01\x02",
    (buf.validate.field).bytes.in = "\x02\x03",
    (buf.validate.field).bytes.in = "\x03\x04"
  ];
  // 0x02, 0x03 NG
  // 0x01, 0x02, 0x03 OK
  bytes not_in_value = 10 [
    (buf.validate.field).bytes.not_in = "\x01\x02",
    (buf.validate.field).bytes.not_in = "\x02\x03",
    (buf.validate.field).bytes.not_in = "\x03\x04"
  ];

  // 0xFF, 0xFF, 0xFF, 0x00 (255.255.255.0) OK
  // \x00\x00\x00\x00\x00\x00\x00\x00\x00\x00
  // \xff\xff\xff\xff\xff\x00   (::ffff:ffff:ff00) OK
  // \x01\x02 NG
  bytes ip_value = 11 [ (buf.validate.field).bytes.ip = true ];
  // 0xFF, 0xFF, 0xFF, 0x00 (255.255.255.0) OK
  // \x01\x02 NG
  bytes ipv4_value = 12 [ (buf.validate.field).bytes.ipv4 = true ];
  // \x00\x00\x00\x00\x00\x00\x00\x00\x00\x00
  // \xff\xff\xff\xff\xff\x00   (::ffff:ffff:ff00) OK
  // \x01\x02 NG
  bytes ipv6_value = 13 [ (buf.validate.field).bytes.ipv6 = true ];

  // 42.0 OK
  // 10.0 NG
  double const_value = 1 [ (buf.validate.field).double.const = 42.0 ];

  // 9.0 OK
  // 10.0 NG
  double lt_value = 2 [ (buf.validate.field).double.lt = 10.0 ];
  // 10.0 OK
  // 11.0 NG
  double lte_value = 3 [ (buf.validate.field).double.lte = 10.0 ];

  // 11.0 OK
  // 10.0 NG
  double gt_value = 4 [ (buf.validate.field).double.gt = 10.0 ];
  // 10.0 OK
  // 9.0 NG
  double gte_value = 5 [ (buf.validate.field).double.gte = 10.0 ];

  // 11.0 OK
  // 13.0 NG
  double in_value = 6 [
    (buf.validate.field).double.in = 10.0,
    (buf.validate.field).double.in = 11.0,
    (buf.validate.field).double.in = 12.0
  ];
  // 11.0 NG
  // 13.0 OK
  double not_in_value = 7 [
    (buf.validate.field).double.not_in = 10.0,
    (buf.validate.field).double.not_in = 11.0,
    (buf.validate.field).double.not_in = 12.0
  ];

  // infinite or NaN NG double only
  double finite_value = 8 [ (buf.validate.field).double.finite = true ];

  enum MyEnum {
    MY_ENUM_UNSPECIFIED = 0;
    MY_ENUM_VALUE1 = 1;
    MY_ENUM_VALUE2 = 2;
    MY_ENUM_VALUE3 = 3;
  }

  // MY_ENUM_VALUE1 OK
  // MY_ENUM_VALUE2 NG
  MyEnum const_value = 1 [ (buf.validate.field).enum.const = 1 ];

  // Undefined Value 4 NG
  MyEnum defined_only_value = 2
      [ (buf.validate.field).enum.defined_only = true ];

  // MY_ENUM_VALUE1 OK
  // MY_ENUM_VALUE3 NG
  MyEnum in_value = 3
      [ (buf.validate.field).enum.in = 1, (buf.validate.field).enum.in = 2 ];
  // MY_ENUM_VALUE1 NG
  // MY_ENUM_VALUE3 OK
  MyEnum not_in_value = 4 [
    (buf.validate.field).enum.not_in = 1,
    (buf.validate.field).enum.not_in = 2
  ];

  // {"key1": "value1", "key2": "value2"} OK
  // {"key1": "value1"} NG
  map<string, string> min_pairs_value = 1
      [ (buf.validate.field).map.min_pairs = 2 ];
  // {"key1": "value1", "key2": "value2"} OK
  // {"key1": "value1", "key2": "value2", "key3": "value3"} NG
  map<string, string> max_pairs_value = 2
      [ (buf.validate.field).map.max_pairs = 2 ];

  // {"a": "value1"} NG
  // {"abcdefghijk": "value1"} NG
  // {"key1": "value1"} OK
  map<string, string> keys_value = 3
      [ (buf.validate.field).map.keys = {string : {min_len : 3 max_len : 10}} ];
  // {"key1": "a"} NG
  // {"key1": "abcdefghijk"} NG
  // {"key1": "value1"} OK
  map<string, string> values_value = 4 [
    (buf.validate.field).map.values = {string : {min_len : 3 max_len : 10}}
  ];

  // ["elm1", "elm2"] OK
  // ["elm1"] NG
  repeated string min_items_value = 1
      [ (buf.validate.field).repeated .min_items = 2 ];
  // ["elm1", "elm2"] OK
  // ["elm1", "el2", "el3"] NG
  repeated string max_items_value = 2
      [ (buf.validate.field).repeated .max_items = 2 ];

  // ["elm1", "elm2"] OK
  // ["elm1", "elm2", "elm2"] NG
  repeated string unique_value = 3
      [ (buf.validate.field).repeated .unique = true ];

  // ["a"] NG
  // ["abcdefghijk"] NG
  repeated string items_value = 4 [
    (buf.validate.field).repeated .items = {string : {min_len : 3 max_len : 10}}
  ];

  // google.protobuf.Int32Value OK
  // google.protobuf.BoolValue NG
  google.protobuf.Any in_value = 1 [
    (buf.validate.field).any.in =
        "type.googleapis.com/google.protobuf.Int32Value",
    (buf.validate.field).any.in =
        "type.googleapis.com/google.protobuf.StringValue"
  ];
  // google.protobuf.Int32Value NG
  // google.protobuf.BoolValue OK
  google.protobuf.Any not_in_value = 2 [
    (buf.validate.field).any.not_in =
        "type.googleapis.com/google.protobuf.Int32Value",
    (buf.validate.field).any.not_in =
        "type.googleapis.com/google.protobuf.StringValue"
  ];

message Duration {
  // Signed seconds of the span of time. Must be from -315,576,000,000
  // to +315,576,000,000 inclusive. Note: these bounds are computed from:
  // 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
  int64 seconds = 1;

  // Signed fractions of a second at nanosecond resolution of the span
  // of time. Durations less than one second are represented with a 0
  // `seconds` field and a positive or negative `nanos` field. For durations
  // of one second or more, a non-zero value for the `nanos` field must be
  // of the same sign as the `seconds` field. Must be from -999,999,999
  // to +999,999,999 inclusive.
  int32 nanos = 2;
}

  // <Go> durationpb.New(5 * time.Second) OK
  google.protobuf.Duration const_value = 1
      [ (buf.validate.field).duration.const = {seconds : 5} ];

  // <Go> durationpb.New(4 * time.Second) OK
  google.protobuf.Duration lt_value = 2
      [ (buf.validate.field).duration.lt = {seconds : 5} ];
  // <Go> durationpb.New(5 * time.Second) OK
  google.protobuf.Duration lte_value = 3
      [ (buf.validate.field).duration.lte = {seconds : 5} ];

  // <Go> durationpb.New(6 * time.Second) OK
  google.protobuf.Duration gt_value = 4
      [ (buf.validate.field).duration.gt = {seconds : 5} ];
  // <Go> durationpb.New(5 * time.Second) OK
  google.protobuf.Duration gte_value = 5
      [ (buf.validate.field).duration.gte = {seconds : 5} ];

  // <Go> durationpb.New(5 * time.Second) OK
  google.protobuf.Duration in_value = 6 [
    (buf.validate.field).duration.in = {seconds : 5},
    (buf.validate.field).duration.in = {seconds : 6},
    (buf.validate.field).duration.in = {seconds : 7}
  ];
  // <Go> durationpb.New(8 * time.Second) OK
  google.protobuf.Duration not_in_value = 7 [
    (buf.validate.field).duration.not_in = {seconds : 5},
    (buf.validate.field).duration.not_in = {seconds : 6},
    (buf.validate.field).duration.not_in = {seconds : 7}
  ];

message Timestamp {
  // Represents seconds of UTC time since Unix epoch
  // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  // 9999-12-31T23:59:59Z inclusive.
  int64 seconds = 1;

  // Non-negative fractions of a second at nanosecond resolution. Negative
  // second values with fractions must still have non-negative nanos values
  // that count forward in time. Must be from 0 to 999,999,999
  // inclusive.
  int32 nanos = 2;
}

  // 　date -u -j -f "%Y-%m-%d %H:%M:%S" "2024-06-03 12:00:00" +%s
  google.protobuf.Timestamp const_value = 1
      [ (buf.validate.field).timestamp.const = {seconds : 1717416000} ];

  // date -j -f "%Y-%m-%d %H:%M:%S" "2024-06-03 11:00:00" +%s
  // > 1717412400 OK
  google.protobuf.Timestamp lt_value = 2
      [ (buf.validate.field).timestamp.lt = {seconds : 1717416000} ];
  // date -j -f "%Y-%m-%d %H:%M:%S" "2024-06-03 12:00:00" +%s
  // > 1717416000 OK
  google.protobuf.Timestamp lte_value = 3
      [ (buf.validate.field).timestamp.lte = {seconds : 1717416000} ];
  google.protobuf.Timestamp lt_now_value = 4
      [ (buf.validate.field).timestamp.lt_now = true ];

  // date -j -f "%Y-%m-%d %H:%M:%S" "2024-06-03 13:00:00" +%s
  // > 1717419600 OK
  google.protobuf.Timestamp gt_value = 5
      [ (buf.validate.field).timestamp.gt = {seconds : 1717416000} ];
  // date -j -f "%Y-%m-%d %H:%M:%S" "2024-06-03 12:00:00" +%s
  // > 1717416000 OK
  google.protobuf.Timestamp gte_value = 6
      [ (buf.validate.field).timestamp.gte = {seconds : 1717416000} ];
  google.protobuf.Timestamp gt_now_value = 7
      [ (buf.validate.field).timestamp.gt_now = true ];

  // バリデーション時の現在時刻から前後1時間以内の時刻であること
  google.protobuf.Timestamp within_value = 8
      [ (buf.validate.field).timestamp.within = {seconds : 3600} ];

  // 2 OK
  // 3 NG
  int32 even_value = 1 [ (buf.validate.field).cel = {
    id : "int32.even",
    message : "value must be even number",
    expression : "this % 2 == 0",
  } ];

  message MyValue { int32 value = 1; }
  enum Status {
    STATUS_UNSPECIFIED = 0;
    STATUS_OK = 1;
  }

  // 値の指定がないとerror
  MyValue required_message_value = 2 [ (buf.validate.field).required = true ];
  // デフォルト値(空文字)だとエラー
  string required_string_value = 3 [ (buf.validate.field).required = true ];
  // デフォルト値(0)だとエラー
  int32 required_int32_value = 4 [ (buf.validate.field).required = true ];
  // 0がだめなのでenumの場合、未定義がエラーになる
  Status required_enum_value = 5 [ (buf.validate.field).required = true ];
  // 要素が0のときエラー
  repeated string required_repeated_value = 6
      [ (buf.validate.field).required = true ];
  // 要素が0のときエラー
  map<string, string> required_map_value = 7
      [ (buf.validate.field).required = true ];

  // 値が指定されていない時にはemail制約を無視する
  string ignore_value = 8 [
    (buf.validate.field).string.email = true,
    (buf.validate.field).ignore = IGNORE_IF_UNPOPULATED
  ];