feat(sidekick/rust): Generate samples for update RPCs

Update RPCs are defined by AIP 134

Author: amanda-tarafa

internal/sidekick/api/model.go

@@ -430,7 +430,8 @@ func (m *Method) IsAIPStandard() bool {
 		m.AIPStandardDeleteInfo() != nil ||
 		m.AIPStandardUndeleteInfo() != nil ||
 		m.AIPStandardListInfo() != nil ||
-		m.AIPStandardCreateInfo() != nil
+		m.AIPStandardCreateInfo() != nil ||
+		m.AIPStandardUpdateInfo() != nil
 }
 
 // AIPStandardGetInfo contains information relevant to get operations
@@ -632,6 +633,74 @@ func (m *Method) AIPStandardCreateInfo() *AIPStandardCreateInfo {
 	}
 }
 
+// AIPStandardUpdateInfo contains information relevant to update operations
+// that are like those defined by AIP-134.
+type AIPStandardUpdateInfo struct {
+	// ResourceRequestField is the field in the method input that contains the resource
+	// to be updated.
+	ResourceRequestField *Field
+	// UpdateMaskRequestField is the field in the method input that contains the update mask.
+	UpdateMaskRequestField *Field
+}
+
+// AIPStandardUpdateInfo returns information relevant to an update operation that is like
+// an update operation as defined by AIP-134, if the method is such an operation.
+func (m *Method) AIPStandardUpdateInfo() *AIPStandardUpdateInfo {
+	if (!m.IsSimple() && !m.IsLRO()) || m.InputType == nil || m.ReturnsEmpty {
+		return nil
+	}
+	var outputResource *Resource
+	if m.OutputType != nil && m.OutputType.Resource != nil {
+		outputResource = m.OutputType.Resource
+	} else if m.OperationInfo != nil {
+		lroResponse := m.LongRunningResponseType()
+		if lroResponse != nil {
+			outputResource = lroResponse.Resource
+		}
+	}
+	if outputResource == nil {
+		return nil
+	}
+
+	// Standard update methods for resource "Foo" should be named "UpdateFoo".
+	maybeSingular, found := strings.CutPrefix(strings.ToLower(m.Name), "update")
+	if !found || maybeSingular == "" {
+		return nil
+	}
+	// The request name should be "UpdateFooRequest".
+	if strings.ToLower(m.InputType.Name) != fmt.Sprintf("update%srequest", maybeSingular) {
+		return nil
+	}
+	// If the resource has a singular name, it must match.
+	if outputResource.Singular != "" &&
+		strings.ToLower(outputResource.Singular) != maybeSingular {
+		return nil
+	}
+
+	// The request needs to have a field for the resource.
+	var targetTypeID string
+	if outputResource.Self != nil {
+		targetTypeID = outputResource.Self.ID
+	}
+	resourceField := findBodyField(m.InputType, m.PathInfo, targetTypeID, maybeSingular)
+	if resourceField == nil {
+		return nil
+	}
+	// The request may have an update mask.
+	var updateMaskField *Field
+	for _, f := range m.InputType.Fields {
+		if f.Name == "update_mask" && f.TypezID == ".google.protobuf.FieldMask" {
+			updateMaskField = f
+			break
+		}
+	}
+
+	return &AIPStandardUpdateInfo{
+		ResourceRequestField:   resourceField,
+		UpdateMaskRequestField: updateMaskField,
+	}
+}
+
 // AIPStandardListInfo contains information relevant to list operations
 // that are like those defined by AIP-132.
 type AIPStandardListInfo struct {

internal/sidekick/api/model_test.go

@@ -1114,6 +1114,121 @@ func TestAIPStandardCreateInfo(t *testing.T) {
 	}
 }
 
+func TestAIPStandardUpdateInfo(t *testing.T) {
+	f := newAIPTestFixture()
+
+	// Setup for Update
+	secretMessage := &Message{ID: "secret_message_id"}
+	f.resource.Self = secretMessage
+
+	resourceField := &Field{
+		Name:    "secret",
+		Typez:   MESSAGE_TYPE,
+		TypezID: secretMessage.ID,
+	}
+	updateMaskField := &Field{
+		Name:    "update_mask",
+		TypezID: ".google.protobuf.FieldMask",
+	}
+
+	testCases := []struct {
+		name   string
+		method *Method
+		want   *AIPStandardUpdateInfo
+	}{
+		{
+			name: "valid update operation",
+			method: &Method{
+				Name: "UpdateSecret",
+				InputType: &Message{
+					Name: "UpdateSecretRequest",
+					Fields: []*Field{
+						resourceField,
+						updateMaskField,
+					},
+				},
+				OutputType: &Message{Resource: f.resource},
+				Model:      f.model,
+			},
+			want: &AIPStandardUpdateInfo{
+				ResourceRequestField:   resourceField,
+				UpdateMaskRequestField: updateMaskField,
+			},
+		},
+		{
+			name: "valid update operation without mask",
+			method: &Method{
+				Name: "UpdateSecret",
+				InputType: &Message{
+					Name: "UpdateSecretRequest",
+					Fields: []*Field{
+						resourceField,
+					},
+				},
+				OutputType: &Message{Resource: f.resource},
+				Model:      f.model,
+			},
+			want: &AIPStandardUpdateInfo{
+				ResourceRequestField: resourceField,
+			},
+		},
+		{
+			name: "invalid update operation (wrong name)",
+			method: &Method{
+				Name: "ModifySecret",
+				InputType: &Message{
+					Name: "UpdateSecretRequest",
+					Fields: []*Field{
+						resourceField,
+					},
+				},
+				OutputType: &Message{Resource: f.resource},
+				Model:      f.model,
+			},
+			want: nil,
+		},
+		{
+			name: "invalid update operation (wrong request name)",
+			method: &Method{
+				Name: "UpdateSecret",
+				InputType: &Message{
+					Name: "ModifySecretRequest",
+					Fields: []*Field{
+						resourceField,
+					},
+				},
+				OutputType: &Message{Resource: f.resource},
+				Model:      f.model,
+			},
+			want: nil,
+		},
+		{
+			name: "invalid update operation (missing resource)",
+			method: &Method{
+				Name: "UpdateSecret",
+				InputType: &Message{
+					Name: "UpdateSecretRequest",
+					Fields: []*Field{
+						updateMaskField,
+					},
+				},
+				OutputType: &Message{Resource: f.resource},
+				Model:      f.model,
+			},
+			want: nil,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			got := tc.method.AIPStandardUpdateInfo()
+			if diff := cmp.Diff(tc.want, got); diff != "" {
+				t.Errorf("AIPStandardUpdateInfo() mismatch (-want +got):\n%s", diff)
+			}
+		})
+	}
+}
+
 func TestAIPStandardListInfo(t *testing.T) {
 	f := newAIPTestFixture()
 

internal/sidekick/rust/templates/common/client_method_samples/builder_fields.mustache

@@ -33,6 +33,12 @@ Use no newline at the end of file so the partials are all merged into a single l
 }}{{/ResourceIDRequestField}}{{!
 }}.set_{{ResourceRequestField.Codec.SetterName}}({{ResourceRequestField.MessageType.Codec.Name}}::new()/* set fields */){{!
 }}{{/AIPStandardCreateInfo}}{{!
+}}{{#AIPStandardUpdateInfo}}{{!
+}}.set_{{ResourceRequestField.Codec.SetterName}}({{ResourceRequestField.MessageType.Codec.Name}}::new().set_name(name)/* set fields */){{!
+}}{{#UpdateMaskRequestField}}{{!
+}}.set_{{Codec.SetterName}}(FieldMask::default().set_paths(["updated", "fields"])){{!
+}}{{/UpdateMaskRequestField}}{{!
+}}{{/AIPStandardUpdateInfo}}{{!
 }}{{#AIPStandardListInfo}}{{!
 }}.set_{{ParentRequestField.Codec.SetterName}}(parent){{!
 }}{{/AIPStandardListInfo}}{{!

internal/sidekick/rust/templates/common/client_method_samples/client_method_sample.mustache

@@ -28,6 +28,13 @@ limitations under the License.
 {{#AIPStandardCreateInfo}}
 /// use {{Service.Model.Codec.PackageNamespace}}::model::{{ResourceRequestField.MessageType.Codec.Name}};
 {{/AIPStandardCreateInfo}}
+{{#AIPStandardUpdateInfo}}
+{{#UpdateMaskRequestField}}
+/// # extern crate wkt as google_cloud_wkt;
+/// use google_cloud_wkt::FieldMask;
+{{/UpdateMaskRequestField}}
+/// use {{Service.Model.Codec.PackageNamespace}}::model::{{ResourceRequestField.MessageType.Codec.Name}};
+{{/AIPStandardUpdateInfo}}
 /// use {{Service.Model.Codec.PackageNamespace}}::Result;
 /// async fn sample(
 {{> /templates/common/client_method_samples/parameters}}

internal/sidekick/rust/templates/common/client_method_samples/parameters.mustache

@@ -32,6 +32,10 @@ limitations under the License.
 ///    id: &str
 {{/ResourceIDRequestField}}
 {{/AIPStandardCreateInfo}}
+{{#AIPStandardUpdateInfo}}
+///    client: &{{Service.Codec.Name}},
+///    name: &str
+{{/AIPStandardUpdateInfo}}
 {{#AIPStandardListInfo}}
 ///    client: &{{Service.Codec.Name}},
 ///    parent: &str