playground/backend/internal/utils/file_utils_test.go

// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements.  See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License.  You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package utils

import (
	"testing"

	pb "beam.apache.org/playground/backend/internal/api/v1"
)

func TestGetFileName(t *testing.T) {
	type args struct {
		name string
		sdk  pb.Sdk
	}
	tests := []struct {
		name           string
		args           args
		expectedResult string
		expectedErr    bool
	}{
		{
			name: "Get file name when name is empty and sdk is JAVA",
			args: args{
				name: "",
				sdk:  pb.Sdk_SDK_JAVA,
			},
			expectedResult: defaultJavaFileName,
		},
		{
			name: "Get file name when name is empty and sdk is GO",
			args: args{
				name: "",
				sdk:  pb.Sdk_SDK_GO,
			},
			expectedResult: defaultGoFileName,
		},
		{
			name: "Get file name when name is empty and sdk is PYTHON",
			args: args{
				name: "",
				sdk:  pb.Sdk_SDK_PYTHON,
			},
			expectedResult: defaultPythonFileName,
		},
		{
			name: "Get file name when name is empty and sdk is SCIO",
			args: args{
				name: "",
				sdk:  pb.Sdk_SDK_SCIO,
			},
			expectedResult: defaultScioFileName,
		},
		{
			name: "Get file name when name is a random string and sdk is JAVA",
			args: args{
				name: "MOCK_NAME",
				sdk:  pb.Sdk_SDK_JAVA,
			},
			expectedResult: "MOCK_NAME" + javaExt,
		},
		{
			name: "Get file name when name has wrong extension and sdk is JAVA",
			args: args{
				name: "MOCK_NAME.py",
				sdk:  pb.Sdk_SDK_JAVA,
			},
			expectedErr: true,
		},
		{
			name: "Get file name when name is a random string and sdk is GO",
			args: args{
				name: "MOCK_NAME",
				sdk:  pb.Sdk_SDK_GO,
			},
			expectedResult: "MOCK_NAME" + goExt,
		},
		{
			name: "Get file name when name has wrong extension and sdk is GO",
			args: args{
				name: "MOCK_NAME.py",
				sdk:  pb.Sdk_SDK_GO,
			},
			expectedErr: true,
		},
		{
			name: "Get file name when name is a random string and sdk is PYTHON",
			args: args{
				name: "MOCK_NAME",
				sdk:  pb.Sdk_SDK_PYTHON,
			},
			expectedResult: "MOCK_NAME" + pythonExt,
		},
		{
			name: "Get file name when name has wrong extension and sdk is PYTHON",
			args: args{
				name: "MOCK_NAME.java",
				sdk:  pb.Sdk_SDK_PYTHON,
			},
			expectedErr: true,
		},
		{
			name: "Get file name when name is a random string and sdk is SCIO",
			args: args{
				name: "MOCK_NAME",
				sdk:  pb.Sdk_SDK_SCIO,
			},
			expectedResult: "MOCK_NAME" + scioExt,
		},
		{
			name: "Get file name when name has wrong extension and sdk is SCIO",
			args: args{
				name: "MOCK_NAME.java",
				sdk:  pb.Sdk_SDK_SCIO,
			},
			expectedErr: true,
		},
		{
			name: "Get file name when name is correct and sdk is JAVA",
			args: args{
				name: "MOCK_NAME.java",
				sdk:  pb.Sdk_SDK_JAVA,
			},
			expectedResult: "MOCK_NAME.java",
		},
		{
			name: "Get file name when name is correct and sdk is GO",
			args: args{
				name: "MOCK_NAME.go",
				sdk:  pb.Sdk_SDK_GO,
			},
			expectedResult: "MOCK_NAME.go",
		},
		{
			name: "Get file name when name is correct and sdk is PYTHON",
			args: args{
				name: "MOCK_NAME.py",
				sdk:  pb.Sdk_SDK_PYTHON,
			},
			expectedResult: "MOCK_NAME.py",
		},
		{
			name: "Get file name when name is correct and sdk is SCIO",
			args: args{
				name: "MOCK_NAME.scala",
				sdk:  pb.Sdk_SDK_SCIO,
			},
			expectedResult: "MOCK_NAME.scala",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			actualResult, err := GetFileName(tt.args.name, "", tt.args.sdk)
			if (err != nil) != tt.expectedErr {
				t.Errorf("GetFileName() unexpected error")
				return
			}
			if actualResult != tt.expectedResult {
				t.Errorf("GetFileName() actual result is not equal to the expected result")
			}
		})
	}
}

func TestIsFileMain(t *testing.T) {
	type args struct {
		content string
		sdk     pb.Sdk
	}
	tests := []struct {
		name           string
		args           args
		expectedResult bool
	}{
		{
			name: "Is file main when code doesn't have main method and sdk is JAVA",
			args: args{
				content: "MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_JAVA,
			},
			expectedResult: false,
		},
		{
			name: "Is file main when code doesn't have main method and sdk is GO",
			args: args{
				content: "MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_GO,
			},
			expectedResult: false,
		},
		{
			name: "Is file main when code doesn't have main method and sdk is PYTHON",
			args: args{
				content: "MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_PYTHON,
			},
			expectedResult: false,
		},
		{
			name: "Is file main when content doesn't have main method and sdk is SCIO",
			args: args{
				content: "MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_SCIO,
			},
			expectedResult: false,
		},
		{
			name: "Is file main when content has main method and sdk is JAVA",
			args: args{
				content: "MOCK_CONTENTpublic static void main(String[] args)MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_JAVA,
			},
			expectedResult: true,
		},
		{
			name: "Is file main when content has main method and sdk is GO",
			args: args{
				content: "MOCK_CONTENTfunc main()MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_GO,
			},
			expectedResult: true,
		},
		{
			name: "Is file main when content has main method and sdk is PYTHON",
			args: args{
				content: "MOCK_CONTENTif __name__ == '__main__'MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_PYTHON,
			},
			expectedResult: true,
		},
		{
			name: "Is file main when content has main method and sdk is SCIO",
			args: args{
				content: "MOCK_CONTENTdef main(cmdlineArgs: Array[String])MOCK_CONTENT",
				sdk:     pb.Sdk_SDK_SCIO,
			},
			expectedResult: true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			actualResult := IsFileMain(tt.args.content, tt.args.sdk)
			if actualResult != tt.expectedResult {
				t.Errorf("IsFileMain() actual result is not equal to the expected result")
			}
		})
	}
}

func TestToSDKFromExt(t *testing.T) {
	tests := []struct {
		name     string
		input    string
		expected pb.Sdk
	}{
		{
			name:     "Transformation a java extension to a Java SDK",
			input:    javaExt,
			expected: pb.Sdk_SDK_JAVA,
		},
		{
			name:     "Transformation a go extension to a GO SDK",
			input:    goExt,
			expected: pb.Sdk_SDK_GO,
		},
		{
			name:     "Transformation a python extension to a Python SDK",
			input:    pythonExt,
			expected: pb.Sdk_SDK_PYTHON,
		},
		{
			name:     "Transformation a scio extension to a SCIO SDK",
			input:    scioExt,
			expected: pb.Sdk_SDK_SCIO,
		},
		{
			name:     "Transformation a random string",
			input:    "MOCK",
			expected: pb.Sdk_SDK_UNSPECIFIED,
		},
		{
			name:     "Transformation a class extension to a Java SDK",
			input:    classExt,
			expected: pb.Sdk_SDK_JAVA,
		},
	}

	for _, tt := range tests {
		t.Run(t.Name(), func(t *testing.T) {
			actual := ToSDKFromExt(tt.input)
			if actual != tt.expected {
				t.Error("Unexpected result during transformation an extension to a SDK")
			}
		})
	}
}