soql_suite_test.go

/*
 * Copyright (c) 2018, salesforce.com, inc.
 * All rights reserved.
 * SPDX-License-Identifier: BSD-3-Clause
 * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 */
package soql_test

import (
	"testing"
	"time"

	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"

	. "github.com/forcedotcom/go-soql"
)

func TestSoql(t *testing.T) {
	RegisterFailHandler(Fail)
	RunSpecs(t, "Soql Suite")
}

type TestSoqlStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
}

type TestSoqlMixedDataAndOperatorStruct struct {
	SelectClause NestedStruct                                `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  QueryCriteriaWithMixedDataTypesAndOperators `soql:"whereClause"`
}

type TestQueryCriteria struct {
	IncludeNamePattern          []string `soql:"likeOperator,fieldName=Host_Name__c"`
	Roles                       []string `soql:"inOperator,fieldName=Role__r.Name"`
	ExcludeNamePattern          []string `soql:"notLikeOperator,fieldName=Host_Name__c"`
	AssetType                   string   `soql:"equalsOperator,fieldName=Tech_Asset__r.Asset_Type_Asset_Type__c"`
	Status                      string   `soql:"notEqualsOperator,fieldName=Status__c"`
	AllowNullLastDiscoveredDate *bool    `soql:"nullOperator,fieldName=Last_Discovered_Date__c"`
	ExcludeIDs                  []string `soql:"notInOperator,fieldName=id"`
}

type NonSoqlStruct struct {
	Key   string
	Value string
}

type NonNestedStruct struct {
	Name          string `soql:"selectColumn,fieldName=Name"`
	SomeValue     string `soql:"selectColumn,fieldName=SomeValue__c"`
	NonSoqlStruct NonSoqlStruct
}

type NestedStruct struct {
	ID              string          `soql:"selectColumn,fieldName=Id"`
	Name            string          `soql:"selectColumn,fieldName=Name__c"`
	NonNestedStruct NonNestedStruct `soql:"selectColumn,fieldName=NonNestedStruct__r"`
}

type TestChildStruct struct {
	SelectClause ChildStruct        `soql:"selectClause,tableName=SM_Application_Versions__c"`
	WhereClause  ChildQueryCriteria `soql:"whereClause"`
}

type TestChildWithOrderByStruct struct {
	SelectClause  ChildStruct `soql:"selectClause,tableName=SM_Application_Versions__c"`
	OrderByClause []Order     `soql:"orderByClause"`
}

type ChildStruct struct {
	Version string `soql:"selectColumn,fieldName=Version__c"`
}

type ChildQueryCriteria struct {
	Name string `soql:"equalsOperator,fieldName=Name__c"`
}

type ParentStruct struct {
	ID                string          `soql:"selectColumn,fieldName=Id"`
	Name              string          `soql:"selectColumn,fieldName=Name__c"`
	NonNestedStruct   NonNestedStruct `soql:"selectColumn,fieldName=NonNestedStruct__r"`
	ChildStruct       TestChildStruct `soql:"selectChild,fieldName=Application_Versions__r"`
	SomeNonSoqlMember string          `json:"some_nonsoql_member"`
}

type OrderByParentStruct struct {
	ID          string                     `soql:"selectColumn,fieldName=Id"`
	Name        string                     `soql:"selectColumn,fieldName=Name__c"`
	ChildStruct TestChildWithOrderByStruct `soql:"selectChild,fieldName=Application_Versions__r"`
}

type DefaultFieldNameParentStruct struct {
	ID                string          `soql:"selectColumn,fieldName=Id"`
	Name              string          `soql:"selectColumn,fieldName=Name__c"`
	NonNestedStruct   NonNestedStruct `soql:"selectColumn,fieldName=NonNestedStruct__r"`
	ChildStruct       TestChildStruct `soql:"selectChild"`
	SomeNonSoqlMember string          `json:"some_nonsoql_member"`
}

type InvalidTestChildStruct struct {
	WhereClause ChildQueryCriteria `soql:"whereClause"`
}
type InvalidParentStruct struct {
	ID          string                 `soql:"selectColumn,fieldName=Id"`
	Name        string                 `soql:"selectColumn,fieldName=Name__c"`
	ChildStruct InvalidTestChildStruct `soql:"selectChild,fieldName=Application_Versions__r"`
}

type InvalidSelectChildClause struct {
	ID          string `soql:"selectColumn,fieldName=Id"`
	Name        string `soql:"selectColumn,fieldName=Name__c"`
	ChildStruct int    `soql:"selectChild,fieldName=Application_Versions__r"`
}

type ChildTagToNonStruct struct {
	ID          string `soql:"selectColumn,fieldName=Id"`
	Name        string `soql:"selectColumn,fieldName=Name__c"`
	ChildStruct string `soql:"selectChild,fieldName=Application_Versions__r"`
}

type MultipleSelectClause struct {
	SelectClause NestedStruct `soql:"selectClause,tableName=SM_Logical_Host__c"`
	ParentStruct ParentStruct `soql:"selectClause,tableName=SM_Table__c"`
}

type MultipleWhereClause struct {
	WhereClause1 ChildQueryCriteria `soql:"whereClause"`
	WhereClause2 ChildQueryCriteria `soql:"whereClause"`
}

type MultipleOrderByClause struct {
	OrderByClause1 []Order `soql:"orderByClause"`
	OrderByClause2 []Order `soql:"orderByClause"`
}

type OnlyWhereClause struct {
	WhereClause TestQueryCriteria `soql:"whereClause"`
}

type OnlyOrderByClause struct {
	OrderByClause []Order `soql:"orderByClause"`
}

type EmptyStruct struct {
}

type InvalidTagInStruct struct {
	SelectClause  NestedStruct       `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause   ChildQueryCriteria `soql:"whereClause"`
	AnotherMember NestedStruct       `soql:"invalidClause,tableName=SM_Logical_Host__c"`
}

type DefaultFieldNameStruct struct {
	DefaultName string `soql:"selectColumn"`
	Description string `soql:"selectColumn,fieldName=Description__c"`
}

type DefaultTableNameStruct struct {
	SomeTableName NestedStruct      `soql:"selectClause"`
	WhereClause   TestQueryCriteria `soql:"whereClause"`
}

type DefaultFieldNameQueryCriteria struct {
	IncludeNamePattern []string `soql:"likeOperator,fieldName=Host_Name__c"`
	Role               []string `soql:"inOperator"`
}

type QueryCriteriaWithIntegerTypes struct {
	NumOfCPUCores                    int   `soql:"equalsOperator,fieldName=Num_of_CPU_Cores__c"`
	PhysicalCPUCount                 int8  `soql:"equalsOperator,fieldName=Physical_CPU_Count__c"`
	NumOfSuccessivePuppetRunFailures int16 `soql:"equalsOperator,fieldName=Number_Of_Successive_Puppet_Run_Failures__c"`
	NumOfCoolanLogFiles              int32 `soql:"equalsOperator,fieldName=Num_Of_Coolan_Log_Files__c"`
	PvtTestFailCount                 int64 `soql:"equalsOperator,fieldName=Pvt_Test_Fail_Count__c"`
}

type QueryCriteriaWithUnsignedIntegerTypes struct {
	NumOfCPUCores                    uint   `soql:"equalsOperator,fieldName=Num_of_CPU_Cores__c"`
	PhysicalCPUCount                 uint8  `soql:"equalsOperator,fieldName=Physical_CPU_Count__c"`
	NumOfSuccessivePuppetRunFailures uint16 `soql:"equalsOperator,fieldName=Number_Of_Successive_Puppet_Run_Failures__c"`
	NumOfCoolanLogFiles              uint32 `soql:"equalsOperator,fieldName=Num_Of_Coolan_Log_Files__c"`
	PvtTestFailCount                 uint64 `soql:"equalsOperator,fieldName=Pvt_Test_Fail_Count__c"`
}

type QueryCriteriaWithFloatTypes struct {
	NumOfCPUCores    float32 `soql:"equalsOperator,fieldName=Num_of_CPU_Cores__c"`
	PhysicalCPUCount float64 `soql:"equalsOperator,fieldName=Physical_CPU_Count__c"`
}

type QueryCriteriaWithFloatPtrTypes struct {
	NumOfCPUCores    *float64 `soql:"equalsOperator,fieldName=Num_of_CPU_Cores__c"`
	PhysicalCPUCount *float64 `soql:"equalsOperator,fieldName=Physical_CPU_Count__c"`
}

type QueryCriteriaWithBooleanType struct {
	NUMAEnabled   bool `soql:"equalsOperator,fieldName=NUMA_Enabled__c"`
	DisableAlerts bool `soql:"equalsOperator,fieldName=Disable_Alerts__c"`
}

type QueryCriteriaWithNoSoqlTag struct {
	NUMAEnabled   bool `soql:"equalsOperator,fieldName=NUMA_Enabled__c"`
	DisableAlerts bool `json:"random_value"`
}

type QueryCriteriaWithBooleanPtrType struct {
	NUMAEnabled   *bool `soql:"equalsOperator,fieldName=NUMA_Enabled__c"`
	DisableAlerts *bool `soql:"equalsOperator,fieldName=Disable_Alerts__c"`
}

type QueryCriteriaWithDateTimeType struct {
	CreatedDate time.Time `soql:"equalsOperator,fieldName=CreatedDate"`
}

type QueryCriteriaWithPtrDateTimeType struct {
	CreatedDate  *time.Time `soql:"equalsOperator,fieldName=CreatedDate"`
	ResolvedDate *time.Time `soql:"equalsOperator,fieldName=ResolvedDate"`
}

type QueryCriteriaNumericComparisonOperators struct {
	NumOfCPUCores                    int `soql:"greaterThanOperator,fieldName=Num_of_CPU_Cores__c"`
	PhysicalCPUCount                 int `soql:"lessThanOperator,fieldName=Physical_CPU_Count__c"`
	NumOfSuccessivePuppetRunFailures int `soql:"greaterThanOrEqualsToOperator,fieldName=Number_Of_Successive_Puppet_Run_Failures__c"`
	NumOfCoolanLogFiles              int `soql:"lessThanOrEqualsToOperator,fieldName=Num_Of_Coolan_Log_Files__c"`
}

type QueryCriteriaDateLiteralsOperatorsInt struct {
	CreatedDate int `soql:"greaterNextNDaysOperator,fieldName=CreatedDate"`
	ClosedDate  int `soql:"lessNextNDaysOperator,fieldName=ClosedDate"`
}

type QueryCriteriaDateLiteralsOperatorsUint struct {
	CreatedDate uint `soql:"greaterNextNDaysOperator,fieldName=CreatedDate"`
	ClosedDate  uint `soql:"lessNextNDaysOperator,fieldName=ClosedDate"`
}

type QueryCriteriaDateLiteralsOperatorsPtr struct {
	CreatedDate   *int `soql:"greaterNextNDaysOperator,fieldName=CreatedDate"`
	OtherDate     *int `soql:"equalsNextNDaysOperator,fieldName=OtherDate"`
	ClosedDate    *int `soql:"lessNextNDaysOperator,fieldName=ClosedDate"`
	ScheduledDate *int `soql:"lessOrEqualNextNDaysOperator,fieldName=ScheduledDate"`
	DeliveredDate *int `soql:"greaterOrEqualNextNDaysOperator,fieldName=DeliveredDate"`
}

type QueryCriteriaDateLastNDaysLiteralsOperatorsPtr struct {
	CreatedDate   *int `soql:"greaterLastNDaysOperator,fieldName=CreatedDate"`
	OtherDate     *int `soql:"equalsLastNDaysOperator,fieldName=OtherDate"`
	ClosedDate    *int `soql:"lessLastNDaysOperator,fieldName=ClosedDate"`
	ScheduledDate *int `soql:"lessOrEqualLastNDaysOperator,fieldName=ScheduledDate"`
	DeliveredDate *int `soql:"greaterOrEqualLastNDaysOperator,fieldName=DeliveredDate"`
}

var TestDateFormat = "2006-01-02"

type QueryCriteriaWithMixedDataTypesAndOperators struct {
	BIOSType                         string     `soql:"equalsOperator,fieldName=BIOS_Type__c"`
	NumOfCPUCores                    int        `soql:"greaterThanOperator,fieldName=Num_of_CPU_Cores__c"`
	NUMAEnabled                      bool       `soql:"equalsOperator,fieldName=NUMA_Enabled__c"`
	PvtTestFailCount                 int64      `soql:"lessThanOrEqualsToOperator,fieldName=Pvt_Test_Fail_Count__c"`
	PhysicalCPUCount                 uint8      `soql:"greaterThanOrEqualsToOperator,fieldName=Physical_CPU_Count__c"`
	CreatedDate                      time.Time  `soql:"equalsOperator,fieldName=CreatedDate,format=2006-01-02"`
	UpdatedDate                      *time.Time `soql:"equalsOperator,fieldName=UpdatedDate,format=2006-01-02"`
	DisableAlerts                    bool       `soql:"equalsOperator,fieldName=Disable_Alerts__c"`
	AllocationLatency                float64    `soql:"lessThanOperator,fieldName=Allocation_Latency__c"`
	MajorOSVersion                   string     `soql:"equalsOperator,fieldName=Major_OS_Version__c"`
	NumOfSuccessivePuppetRunFailures uint32     `soql:"equalsOperator,fieldName=Number_Of_Successive_Puppet_Run_Failures__c"`
	LastRestart                      time.Time  `soql:"greaterThanOperator,fieldName=Last_Restart__c"`
	Memory                           *float64   `soql:"equalsOperator,fieldName=Memory__c"`
	NumHardDrives                    *int       `soql:"equalsOperator,fieldName=NumHardDrives__c"`
	ClosedDate                       int        `soql:"greaterNextNDaysOperator,fieldName=ClosedDate"`
}

type InvalidSelectClause struct {
	SelectClause string `soql:"selectClause,tableName=SM_Logical_Host__c"`
}

type TestSoqlOrderByStruct struct {
	SelectClause  NestedStruct `soql:"selectClause,tableName=SM_Logical_Host__c"`
	OrderByClause []Order      `soql:"orderByClause"`
}

type TestSoqlChildRelationOrderByStruct struct {
	SelectClause  OrderByParentStruct `soql:"selectClause,tableName=SM_Logical_Host__c"`
	OrderByClause []Order             `soql:"orderByClause"`
}

type TestSoqlLimitStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
	Limit        *int              `soql:"limitClause"`
}

type TestSoqlInvalidLimitStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
	Limit        string            `soql:"limitClause"`
}

type TestSoqlMultipleLimitStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
	Limit        *int              `soql:"limitClause"`
	AlsoLimit    *int              `soql:"limitClause"`
}

type ParentLimitStruct struct {
	ID          string           `soql:"selectColumn,fieldName=Id"`
	Name        string           `soql:"selectColumn,fieldName=Name__c"`
	ChildStruct ChildLimitStruct `soql:"selectChild,fieldName=Application_Versions__r"`
}

type ChildLimitStruct struct {
	SelectClause TestChildLimitSelect `soql:"selectClause,tableName=Application_Versions__c"`
	Limit        *int                 `soql:"limitClause"`
}

type TestChildLimitSelect struct {
	ID      string `soql:"selectColumn,fieldName=Id"`
	Version string `soql:"selectColumn,fieldName=Version__c"`
}

type TestSoqlChildRelationLimitStruct struct {
	SelectClause ParentLimitStruct `soql:"selectClause,tableName=SM_Logical_Host__c"`
	Limit        *int              `soql:"limitClause"`
}

type TestSoqlOffsetStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
	Offset       *int              `soql:"offsetClause"`
}

type TestSoqlInvalidOffsetStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
	Offset       string            `soql:"offsetClause"`
}

type TestSoqlMultipleOffsetStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
	Offset       *int              `soql:"offsetClause"`
	AlsoOffset   *int              `soql:"offsetClause"`
}

type TestSoqlLimitAndOffsetStruct struct {
	SelectClause NestedStruct      `soql:"selectClause,tableName=SM_Logical_Host__c"`
	WhereClause  TestQueryCriteria `soql:"whereClause"`
	Limit        *int              `soql:"limitClause"`
	Offset       *int              `soql:"offsetClause"`
}

// setups for OR and subfilter tests

type orSOQLQuery struct {
	SelectClause contact                `soql:"selectClause,tableName=Contact"`
	WhereClause  positionOrDeptCriteria `soql:"whereClause,joiner=OR"`
}

type orLowerSOQLQuery struct {
	SelectClause contact                `soql:"selectClause,tableName=Contact"`
	WhereClause  positionOrDeptCriteria `soql:"whereClause,joiner=or"`
}

type andSOQLQuery struct {
	SelectClause contact                `soql:"selectClause,tableName=Contact"`
	WhereClause  positionOrDeptCriteria `soql:"whereClause,joiner=AND"`
}

type invalidJoinerSOQLQuery struct {
	SelectClause contact                `soql:"selectClause,tableName=Contact"`
	WhereClause  positionOrDeptCriteria `soql:"whereClause,joiner=not-a-real-value"`
}

type noJoinerSOQLQuery struct {
	SelectClause contact                `soql:"selectClause,tableName=Contact"`
	WhereClause  positionOrDeptCriteria `soql:"whereClause"`
}

type positionOrDeptCriteria struct {
	Title      string `soql:"equalsOperator,fieldName=Title"`
	Department string `soql:"equalsOperator,fieldName=Department"`
}

type contact struct {
	Name  string `soql:"selectColumn,fieldName=Name" json:"Name"`
	Email string `soql:"selectColumn,fieldName=Email" json:"Email"`
	Phone string `soql:"selectColumn,fieldName=Phone" json:"Phone"`
}

type queryCriteria struct {
	Position    positionCriteria    `soql:"subquery,joiner=OR"`
	Contactable contactableCriteria `soql:"subquery,joiner=OR"`
}

type contactableCriteria struct {
	EmailOK emailCheck `soql:"subquery,joiner=and"`
	PhoneOK phoneCheck `soql:"subquery,joiner=and"`
}

type emailCheck struct {
	Email         bool `soql:"nullOperator,fieldName=Email"`
	EmailOptedOut bool `soql:"equalsOperator,fieldName=HasOptedOutOfEmail"`
}

type phoneCheck struct {
	Phone     bool `soql:"nullOperator,fieldName=Phone"`
	DoNotCall bool `soql:"equalsOperator,fieldName=DoNotCall"`
}

type positionCriteria struct {
	Title             string              `soql:"equalsOperator,fieldName=Title"`
	DepartmentManager deptManagerCriteria `soql:"subquery"`
}

type deptManagerCriteria struct {
	Department string   `soql:"equalsOperator,fieldName=Department"`
	Title      []string `soql:"likeOperator,fieldName=Title"`
}

type soqlSubQueryTestStruct struct {
	SelectClause contact       `soql:"selectClause,tableName=Contact"`
	WhereClause  queryCriteria `soql:"whereClause"`
}

type soqlSubQueryInvalidTypeTestStruct struct {
	SelectClause contact                 `soql:"selectClause,tableName=Contact"`
	WhereClause  invalidSubqueryCriteria `soql:"whereClause"`
}

type invalidSubqueryCriteria struct {
	Position    string              `soql:"subquery,joiner=OR"`
	Contactable contactableCriteria `soql:"subquery,joiner=OR"`
}

type soqlSubQueryPtrTestStruct struct {
	SelectClause contact             `soql:"selectClause,tableName=Contact"`
	WhereClause  ptrSubqueryCriteria `soql:"whereClause"`
}

type ptrSubqueryCriteria struct {
	Position    *positionCriteria    `soql:"subquery,joiner=OR"`
	Contactable *contactableCriteria `soql:"subquery,joiner=OR"`
}

type soqlSubQueryInTestStruct struct {
	SelectClause contact            `soql:"selectClause,tableName=Contact"`
	WhereClause  inSubqueryCriteria `soql:"whereClause"`
}

type inSubqueryCriteria struct {
	Type                         string           `soql:"equalsOperator,fieldName=Type"`
	NotInFraudTable              *soqlFraudStruct `soql:"subquery,joiner=NOT IN,fieldName=Name"`
	InFraudTable                 *soqlFraudStruct `soql:"subquery,joiner=IN,fieldName=Name"`
	InFraudTableWithoutFieldName *soqlFraudStruct `soql:"subquery,joiner=IN"`
	Country                      string           `soql:"equalsOperator,fieldName=Country"`
}

type fraudCriteria struct {
	IsFraud bool `soql:"equalsOperator,fieldName=isFraud"`
}

type soqlFraudStruct struct {
	SelectClause contact       `soql:"selectClause,tableName=Fraud"`
	WhereClause  fraudCriteria `soql:"whereClause"`
}