framework/private/test/filter_test.cpp

/**
 *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.
 */
/*
 * filter_test.cpp
 *
 *  \date       Feb 11, 2013
 *  \author     <a href="mailto:dev@celix.apache.org">Apache Celix Project Team</a>
 *  \copyright  Apache License, Version 2.0
 */
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

#include "CppUTest/TestHarness.h"
#include "CppUTest/TestHarness_c.h"
#include "CppUTest/CommandLineTestRunner.h"
#include "CppUTestExt/MockSupport.h"

extern "C" {
#include "filter_private.h"
#include "celix_log.h"

framework_logger_pt logger = (framework_logger_pt) 0x42;
}

int main(int argc, char** argv) {
	return RUN_ALL_TESTS(argc, argv);
}

static char* my_strdup(const char* s){
	if(s==NULL){
		return NULL;
	}

	size_t len = strlen(s);

	char *d = (char*) calloc (len + 1,sizeof(char));

	if (d == NULL){
		return NULL;
	}

	strncpy (d,s,len);
	return d;
}

//----------------TESTGROUPS----------------
TEST_GROUP(filter) {
	void setup(void) {
	}

	void teardown() {
		mock().clear();
	}
};

//----------------FILTER TESTS----------------
TEST(filter, create_destroy){
	char * filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=attr3)))");
	filter_pt get_filter;

	get_filter = filter_create(filter_str);
	CHECK(get_filter != NULL);

	filter_destroy(get_filter);

	//cleanup
	free(filter_str);

	mock().checkExpectations();
}

TEST(filter, create_fail_missing_opening_brackets){
	char * filter_str;
	filter_pt get_filter;

	//test missing opening brackets in main filter
	mock().expectNCalls(2, "framework_log");
	filter_str = my_strdup("&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=attr3))");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test missing opening brackets in AND comparator
	mock().expectNCalls(3, "framework_log");
	filter_str = my_strdup("(&test_attr1=attr1|(test_attr2=attr2)(test_attr3=attr3))");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test missing opening brackets in AND comparator
	mock().expectNCalls(4, "framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(|test_attr2=attr2(test_attr3=attr3))");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test missing opening brackets in NOT comparator
	mock().expectNCalls(4, "framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(!test_attr2=attr2)");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();
}

TEST(filter, create_fail_missing_closing_brackets){
	char * filter_str;
	filter_pt get_filter;
	//test missing closing brackets in substring
	mock().expectNCalls(5, "framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=attr3");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test missing closing brackets in value
	mock().expectNCalls(4, "framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3>=attr3");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();
}

TEST(filter, create_fail_invalid_closing_brackets){
	char * filter_str;
	filter_pt get_filter;
	//test missing closing brackets in substring
	mock().expectNCalls(6, "framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=at(tr3)))");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test missing closing brackets in value
	mock().expectNCalls(5, "framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3>=att(r3)))");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();
}

TEST(filter, create_misc){
	char * filter_str;
	filter_pt get_filter;
	//test trailing chars
	mock().expectOneCall("framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=attr3))) oh no! trailing chars");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test half APPROX operator (should be "~=", instead is "~")
	mock().expectNCalls(5, "framework_log");
	filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3~attr3)))");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test PRESENT operator with trailing chars (should just register as substrings: "*" and "attr3")
	filter_str = my_strdup("(test_attr3=*attr3)");
	get_filter = filter_create(filter_str);
	CHECK(get_filter != NULL);
	LONGS_EQUAL(SUBSTRING, get_filter->operand)
	LONGS_EQUAL(2, arrayList_size((array_list_pt) get_filter->value));
	filter_destroy(get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test parsing a attribute of 0 length
	mock().expectNCalls(3, "framework_log");
	filter_str = my_strdup("(>=attr3)");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test parsing a value of 0 length
	mock().expectOneCall("framework_log");
	filter_str = my_strdup("(test_attr3>=)");
	get_filter = filter_create(filter_str);
	POINTERS_EQUAL(NULL, get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test parsing a value with a escaped closing bracket "\)"
	filter_str = my_strdup("(test_attr3>=strWith\\)inIt)");
	get_filter = filter_create(filter_str);
	CHECK(get_filter != NULL);
	STRCMP_EQUAL("strWith)inIt", (char*)get_filter->value);
	filter_destroy(get_filter);
	free(filter_str);
	mock().checkExpectations();

	//test parsing a substring with a escaped closing bracket "\)"
	filter_str = my_strdup("(test_attr3=strWith\\)inIt)");
	get_filter = filter_create(filter_str);
	CHECK(get_filter != NULL);
	STRCMP_EQUAL("strWith)inIt", (char*)get_filter->value);
	filter_destroy(get_filter);
	free(filter_str);
	mock().checkExpectations();
}

TEST(filter, match_comparators){
	char * filter_str;
	filter_pt filter;
	properties_pt props = properties_create();
	char * key = my_strdup("test_attr1");
	char * val = my_strdup("attr1");
	char * key2 = my_strdup("test_attr2");
	char * val2 = my_strdup("attr2");
	properties_set(props, key, val);
	properties_set(props, key2, val2);

	//test AND
	filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(!(test_attr3=attr3))))");
	filter = filter_create(filter_str);
	bool result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test AND false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(&(test_attr1=attr1)(test_attr1=attr2))");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//cleanup
	properties_destroy(props);
	filter_destroy(filter);
	free(filter_str);
	free(key);
	free(key2);
	free(val);
	free(val2);

	mock().checkExpectations();
}

TEST(filter, match_operators){
	char * filter_str;
	filter_pt filter;
	properties_pt props = properties_create();
	char * key = my_strdup("test_attr1");
	char * val = my_strdup("attr1");
	char * key2 = my_strdup("test_attr2");
	char * val2 = my_strdup("attr2");
	properties_set(props, key, val);
	properties_set(props, key2, val2);

	//test EQUALS
	filter_str = my_strdup("(test_attr1=attr1)");
	filter = filter_create(filter_str);
	bool result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test EQUALS false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1=falseString)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test APPROX TODO: update this test once APPROX is implemented
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1~=attr1)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test APROX false TODO: update this test once APPROX is implemented
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1~=ATTR1)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test PRESENT
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1=*)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test PRESENT false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr3=*)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test LESSEQUAL less
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1<=attr5)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test LESSEQUAL equals
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2<=attr2)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test LESSEQUAL false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2<=attr1)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test GREATEREQUAL greater
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2>=attr1)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test GREATEREQUAL equals
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2>=attr2)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test GREATEREQUAL false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1>=attr5)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test LESS less
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1<attr5)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test LESS equals
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2<attr2)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test LESS false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2<attr1)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test GREATER greater
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2>attr1)");
	filter = filter_create(filter_str);
	result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//test GREATER equals
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr2>attr2)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test GREATER false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1>attr5)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//test SUBSTRING equals
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1=attr*)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK(result);

	//test SUBSTRING false
	filter_destroy(filter);
	free(filter_str);
	filter_str = my_strdup("(test_attr1=attr*charsNotPresent)");
	filter = filter_create(filter_str);
	result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//cleanup
	properties_destroy(props);
	filter_destroy(filter);
	free(filter_str);
	free(key);
	free(key2);
	free(val);
	free(val2);

	mock().checkExpectations();
}

TEST(filter, match_recursion){

	char * filter_str = my_strdup("(&(test_attr1=attr1)(|(&(test_attr2=attr2)(!(&(test_attr1=attr1)(test_attr3=attr3))))(test_attr3=attr3)))");
	filter_pt filter = filter_create(filter_str);
	properties_pt props = properties_create();
	char * key = my_strdup("test_attr1");
	char * val = my_strdup("attr1");
	char * key2 = my_strdup("test_attr2");
	char * val2 = my_strdup("attr2");
	properties_set(props, key, val);
	properties_set(props, key2, val2);

	bool result = false;
	filter_match(filter, props, &result);
	CHECK(result);

	//cleanup
	properties_destroy(props);
	filter_destroy(filter);
	free(filter_str);
	free(key);
	free(key2);
	free(val);
	free(val2);

	mock().checkExpectations();
}

TEST(filter, match_false){
	char * filter_str = my_strdup("(&(test_attr1=attr1)(&(test_attr2=attr2)(test_attr3=attr3)))");
	filter_pt filter = filter_create(filter_str);
	properties_pt props = properties_create();
	char * key = my_strdup("test_attr1");
	char * val = my_strdup("attr1");
	char * key2 = my_strdup("test_attr2");
	char * val2 = my_strdup("attr2");
	properties_set(props, key, val);
	properties_set(props, key2, val2);

	bool result = true;
	filter_match(filter, props, &result);
	CHECK_FALSE(result);

	//cleanup
	properties_destroy(props);
	filter_destroy(filter);
	free(filter_str);
	free(key);
	free(key2);
	free(val);
	free(val2);

	mock().checkExpectations();
}

TEST(filter, match_filter){
	char * filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=attr3)))");
	char * compareTo_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=attr3)))");
	filter_pt filter = filter_create(filter_str);
	filter_pt compareTo = filter_create(compareTo_str);

	bool result;
	filter_match_filter(filter, compareTo, &result);

	//cleanup
	filter_destroy(filter);
	filter_destroy(compareTo);
	free(filter_str);
	free(compareTo_str);

	mock().checkExpectations();
}

TEST(filter, getString){
	char * filter_str = my_strdup("(&(test_attr1=attr1)(|(test_attr2=attr2)(test_attr3=attr3)))");
	filter_pt filter = filter_create(filter_str);

	char * get_str;
	filter_getString(filter, &get_str);

	//cleanup
	filter_destroy(filter);
	free(filter_str);

	mock().checkExpectations();
}