Skip to content

Change tsk_table_collection_equals to take options. #917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2020
Merged

Change tsk_table_collection_equals to take options. #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions c/CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
[0.99.8] - 2020-XX-XX
---------------------

**New features**
**Breaking changes**

- Added ``tsk_table_collection_equals_with_options`` which allows for more flexible equality
criteria (e.g., ignore top-level metadata and schema or provenance tables).
(:user:`mufernando`, :issue:`896`, :pr:`897`)
- Added an ``options`` argument to ``tsk_table_collection_equals``
and table equality methods to allow for more flexible equality criteria
(e.g., ignore top-level metadata and schema or provenance tables).
Existing code should add an extra final parameter ``0`` to retain the
current behaviour. (:user:`mufernando`, :user:`jeromekelleher`,
:issue:`896`, :pr:`897`, :issue:`913`, :pr:`917`).

---------------------
[0.99.7] - 2020-09-29
Expand Down Expand Up @@ -35,7 +38,7 @@
**Breaking changes**

- The macro ``TSK_IMPUTE_MISSING_DATA`` is renamed to ``TSK_ISOLATED_NOT_MISSING``
(:user:`benjeffery`, :issue:`716`, :pr:`794`)
(:user:`benjeffery`, :issue:`716`, :pr:`794`)

**New features**

Expand Down
24 changes: 12 additions & 12 deletions c/tests/test_file_format.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ test_missing_optional_column_pairs(void)
copy_store_drop_columns(ts, 2, drop_cols, _tmp_file_name);
ret = tsk_table_collection_load(&t2, _tmp_file_name, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_FALSE(tsk_table_collection_equals(&t1, &t2));
CU_ASSERT_FALSE(tsk_table_collection_equals(&t1, &t2, 0));
tsk_table_collection_free(&t2);
}

Expand Down Expand Up @@ -484,7 +484,7 @@ test_missing_indexes(void)
copy_store_drop_columns(ts, 2, cols, _tmp_file_name);
ret = tsk_table_collection_load(&t2, _tmp_file_name, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2));
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2, 0));
CU_ASSERT_FALSE(tsk_table_collection_has_index(&t2, 0));
tsk_table_collection_free(&t2);

Expand Down Expand Up @@ -633,7 +633,7 @@ test_metadata_schemas_optional(void)
ret = tsk_table_collection_load(&t2, _tmp_file_name, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
/* metadata schemas are included in data comparisons */
CU_ASSERT_FALSE(tsk_table_collection_equals(&t1, &t2));
CU_ASSERT_FALSE(tsk_table_collection_equals(&t1, &t2, 0));
tsk_table_collection_free(&t2);
}

Expand Down Expand Up @@ -933,12 +933,12 @@ test_example_round_trip(void)
CU_ASSERT_EQUAL_FATAL(ret, 0);
ret = tsk_table_collection_load(&t2, _tmp_file_name, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2));
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2, 0));

/* Reading multiple times into the same tables with TSK_NO_INIT is supported. */
ret = tsk_table_collection_load(&t2, _tmp_file_name, TSK_NO_INIT);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2));
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2, 0));
tsk_table_collection_free(&t2);

/* Do the same thing with treeseq API */
Expand All @@ -947,7 +947,7 @@ test_example_round_trip(void)
CU_ASSERT_EQUAL_FATAL(ret, 0);
ret = tsk_treeseq_load(&ts2, _tmp_file_name, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, ts2.tables));
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, ts2.tables, 0));
tsk_treeseq_free(&ts2);

/* Use loadf form */
Expand All @@ -957,7 +957,7 @@ test_example_round_trip(void)
fseek(f, 0, SEEK_SET);
ret = tsk_table_collection_loadf(&t2, f, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2));
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2, 0));
tsk_table_collection_free(&t2);
fclose(f);

Expand All @@ -968,7 +968,7 @@ test_example_round_trip(void)
fseek(f, 0, SEEK_SET);
ret = tsk_treeseq_loadf(&ts2, f, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, ts2.tables));
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, ts2.tables, 0));
tsk_treeseq_free(&ts2);

fclose(f);
Expand Down Expand Up @@ -1004,7 +1004,7 @@ test_multiple_round_trip(void)
for (j = 0; j < num_examples; j++) {
ret = tsk_table_collection_loadf(&out_tables, f, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&in_tables[j], &out_tables));
CU_ASSERT_TRUE(tsk_table_collection_equals(&in_tables[j], &out_tables, 0));
tsk_table_collection_free(&out_tables);
}

Expand All @@ -1015,7 +1015,7 @@ test_multiple_round_trip(void)
for (j = 0; j < num_examples; j++) {
ret = tsk_table_collection_loadf(&out_tables, f, TSK_NO_INIT);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&in_tables[j], &out_tables));
CU_ASSERT_TRUE(tsk_table_collection_equals(&in_tables[j], &out_tables, 0));
}
tsk_table_collection_free(&out_tables);

Expand All @@ -1030,7 +1030,7 @@ test_multiple_round_trip(void)
break;
}
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&in_tables[j], &out_tables));
CU_ASSERT_TRUE(tsk_table_collection_equals(&in_tables[j], &out_tables, 0));
j++;
}
tsk_table_collection_free(&out_tables);
Expand All @@ -1055,7 +1055,7 @@ test_copy_store_drop_columns(void)
copy_store_drop_columns(ts, 0, NULL, _tmp_file_name);
ret = tsk_table_collection_load(&t2, _tmp_file_name, 0);
CU_ASSERT_EQUAL_FATAL(ret, 0);
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2));
CU_ASSERT_TRUE(tsk_table_collection_equals(&t1, &t2, 0));

tsk_table_collection_free(&t1);
tsk_table_collection_free(&t2);
Expand Down
Loading