check_message_oneofs_fields_not_removed.go

// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package breaking

import (
	"github.com/uber/prototool/internal/extract"
	"github.com/uber/prototool/internal/text"
)

func checkMessageOneofsFieldsNotRemoved(addFailure func(*text.Failure), from *extract.PackageSet, to *extract.PackageSet) error {
	return forEachMessageOneofPair(addFailure, from, to, checkMessageOneofsFieldsNotRemovedMessageOneof)
}

func checkMessageOneofsFieldsNotRemovedMessageOneof(addFailure func(*text.Failure), from *extract.MessageOneof, to *extract.MessageOneof) error {
	fromFieldNumbers := getMessageOneofFieldNumbersMap(from.ProtoMessage().FieldNumbers)
	toFieldNumbers := getMessageOneofFieldNumbersMap(to.ProtoMessage().FieldNumbers)
	for fromFieldNumber := range fromFieldNumbers {
		if _, ok := toFieldNumbers[fromFieldNumber]; !ok {
			addFailure(newMessageOneofsFieldsNotRemovedFailure(from.Message().FullyQualifiedName(), from.ProtoMessage().Name, fromFieldNumber))
		}
	}
	return nil
}

func newMessageOneofsFieldsNotRemovedFailure(messageName string, oneofName string, fromFieldNumber int32) *text.Failure {
	return newTextFailuref(`Message oneof %q on message %q had field "%d" removed.`, oneofName, messageName, fromFieldNumber)
}

func getMessageOneofFieldNumbersMap(fieldNumbers []int32) map[int32]struct{} {
	m := make(map[int32]struct{}, len(fieldNumbers))
	for _, fieldNumber := range fieldNumbers {
		m[fieldNumber] = struct{}{}
	}
	return m
}