github.com/google/osv-scalibr@v0.4.1/extractor/filesystem/runtime/nodejs/nodeversion/metadata/metadata_test.go (about)

     1  // Copyright 2025 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  //      http://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 metadata_test
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/google/go-cmp/cmp"
    21  	"github.com/google/osv-scalibr/extractor/filesystem/runtime/nodejs/nodeversion/metadata"
    22  	"google.golang.org/protobuf/proto"
    23  	"google.golang.org/protobuf/testing/protocmp"
    24  
    25  	pb "github.com/google/osv-scalibr/binary/proto/scan_result_go_proto"
    26  )
    27  
    28  func TestSetProto(t *testing.T) {
    29  	testCases := []struct {
    30  		desc string
    31  		m    *metadata.Metadata
    32  		p    *pb.Package
    33  		want *pb.Package
    34  	}{
    35  		{
    36  			desc: "nil_metadata",
    37  			m:    nil,
    38  			p:    &pb.Package{Name: "some-package"},
    39  			want: &pb.Package{Name: "some-package"},
    40  		},
    41  		{
    42  			desc: "nil_package",
    43  			m: &metadata.Metadata{
    44  				NodeJsVersion: "name",
    45  			},
    46  			p:    nil,
    47  			want: nil,
    48  		},
    49  		{
    50  			desc: "set_metadata",
    51  			m: &metadata.Metadata{
    52  				NodeJsVersion: "name",
    53  			},
    54  			p: &pb.Package{Name: "some-package"},
    55  			want: &pb.Package{
    56  				Name: "some-package",
    57  				Metadata: &pb.Package_NodeversionMetadata{
    58  					NodeversionMetadata: &pb.NodeVersionMetadata{
    59  						NodejsVersion: "name",
    60  					},
    61  				},
    62  			},
    63  		},
    64  		{
    65  			desc: "override_metadata",
    66  			m: &metadata.Metadata{
    67  				NodeJsVersion: "another-name",
    68  			},
    69  			p: &pb.Package{
    70  				Name: "some-package",
    71  				Metadata: &pb.Package_NodeversionMetadata{
    72  					NodeversionMetadata: &pb.NodeVersionMetadata{
    73  						NodejsVersion: "name",
    74  					},
    75  				},
    76  			},
    77  			want: &pb.Package{
    78  				Name: "some-package",
    79  				Metadata: &pb.Package_NodeversionMetadata{
    80  					NodeversionMetadata: &pb.NodeVersionMetadata{
    81  						NodejsVersion: "another-name",
    82  					},
    83  				},
    84  			},
    85  		},
    86  		{
    87  			desc: "set_all_fields",
    88  			m: &metadata.Metadata{
    89  				NodeJsVersion: "name",
    90  			},
    91  			p: &pb.Package{Name: "some-package"},
    92  			want: &pb.Package{
    93  				Name: "some-package",
    94  				Metadata: &pb.Package_NodeversionMetadata{
    95  					NodeversionMetadata: &pb.NodeVersionMetadata{
    96  						NodejsVersion: "name",
    97  					},
    98  				},
    99  			},
   100  		},
   101  	}
   102  
   103  	for _, tc := range testCases {
   104  		t.Run(tc.desc, func(t *testing.T) {
   105  			p := proto.Clone(tc.p).(*pb.Package)
   106  			tc.m.SetProto(p)
   107  			opts := []cmp.Option{
   108  				protocmp.Transform(),
   109  			}
   110  			if diff := cmp.Diff(tc.want, p, opts...); diff != "" {
   111  				t.Errorf("Metatadata{%+v}.SetProto(%+v): (-want +got):\n%s", tc.m, tc.p, diff)
   112  			}
   113  
   114  			// Test the reverse conversion for completeness.
   115  
   116  			if tc.p == nil && tc.want == nil {
   117  				return
   118  			}
   119  
   120  			got := metadata.ToStruct(p.GetNodeversionMetadata())
   121  			if diff := cmp.Diff(tc.m, got); diff != "" {
   122  				t.Errorf("ToStruct(%+v): (-want +got):\n%s", p.GetNodeversionMetadata(), diff)
   123  			}
   124  		})
   125  	}
   126  }
   127  
   128  func TestToStruct(t *testing.T) {
   129  	testCases := []struct {
   130  		desc string
   131  		m    *pb.NodeVersionMetadata
   132  		want *metadata.Metadata
   133  	}{
   134  		{
   135  			desc: "nil",
   136  			m:    nil,
   137  			want: nil,
   138  		},
   139  		{
   140  			desc: "some_fields",
   141  			m: &pb.NodeVersionMetadata{
   142  				NodejsVersion: "name",
   143  			},
   144  			want: &metadata.Metadata{
   145  				NodeJsVersion: "name",
   146  			},
   147  		},
   148  		{
   149  			desc: "all_fields",
   150  			m: &pb.NodeVersionMetadata{
   151  				NodejsVersion: "name",
   152  			},
   153  			want: &metadata.Metadata{
   154  				NodeJsVersion: "name",
   155  			},
   156  		},
   157  	}
   158  
   159  	for _, tc := range testCases {
   160  		t.Run(tc.desc, func(t *testing.T) {
   161  			got := metadata.ToStruct(tc.m)
   162  			if diff := cmp.Diff(tc.want, got); diff != "" {
   163  				t.Errorf("ToStruct(%+v): (-want +got):\n%s", tc.m, diff)
   164  			}
   165  
   166  			if tc.m == nil {
   167  				return
   168  			}
   169  
   170  			// Test the reverse conversion for completeness.
   171  
   172  			gotP := &pb.Package{}
   173  			wantP := &pb.Package{
   174  				Metadata: &pb.Package_NodeversionMetadata{
   175  					NodeversionMetadata: tc.m,
   176  				},
   177  			}
   178  			got.SetProto(gotP)
   179  			opts := []cmp.Option{
   180  				protocmp.Transform(),
   181  			}
   182  			if diff := cmp.Diff(wantP, gotP, opts...); diff != "" {
   183  				t.Errorf("Metatadata{%+v}.SetProto(%+v): (-want +got):\n%s", got, wantP, diff)
   184  			}
   185  		})
   186  	}
   187  }