Update firestore filtering

[danghai]

Fix #431

[danghai]

@spbnick , I am not sure why check_deployment is still skipped? It is because of failing flake8?

[spbnick]

Yeah, it's only executed when everything else has passed, IIRC, to save resources.

[danghai]

Do you have the command that I can run the test locally? I mean this one:

  File "/home/runner/work/kcidb/kcidb/kcidb/test_monitor.py", line 841, in test_email_generated
    assert len(remaining_obj_types) == 0, \
AssertionError: Missing ***'build', 'test', 'checkout', 'revision'*** emails for <class 'kcidb_io.schema.v03_00.Version'>
assert 4 == 0
 +  where 4 = len(***'build', 'checkout', 'revision', 'test'***)

I change test_wipe_main, it passes this testcase; However it is failing test_monitor. I am not sure why

[danghai]

Oh it passes now after re-run :D. @spbnick could you review my PR? It resolves the warning.

[spbnick]

Do you have the command that I can run the test locally? I mean this one:

Most of the tests you can run with just pytest. However, some of the tests require access to a deployment, which requires you creating a Google Cloud project (you can have six months of free trial if you provide a credit card, IIRC).

The general workflow looks something like this:

./cloud deploy "<gcp_project>" "<namespace>" 1 -v --smtp-mocked --test --heavy-asserts # Create a deployment in your project
./cloud shell "<gcp_project>" "<namespace>" 1 --smtp-mocked --test --heavy-asserts # Start a shell with environment variables pointing to the deployment
export KCIDB_DEPLOYMENT="This deployment is empty" # Only do this with *actual* empty deployments, needed for the monitor test
pytest # Run the tests, repeat as many times as necessary, with whatever options you need
exit # Exit the shell
./cloud withdraw "<gcp_project>" "<namespace>" 1 -v --smtp-mocked --test # Withdraw (destroy) the deployment (leaving some shared objects behind)

Where <gcp_project> is the name of the Google Cloud Project you have created. And <namespace> is a "namespace" - a prefix for the names of (almost) all created objects, that lets you distinguish deployments within a single project. The latter can be an empty string.

There's of course much more to it, but you can start with these, and modify, after reading the corresponding --help output and the docs, where there are any.

[spbnick]

Oh it passes now after re-run :D. @spbnick could you review my PR? It resolves the warning.

Ah great! However, in general the test shouldn't be flaky and this warrants investigation. Don't rerun it if you see it again, let me see what's going on first, please.

The change looks good, but the commit message could be better. As such it reads like "Change firestore filtering", and doesn't say much. Could you make it clearer? Even better if it has a reference to the Google documentation covering this change in the API.

Thank you 🙇‍♂️

[danghai]

@spbnick Thank you. I add more information for the change

[spbnick]

LGTM! Thank you, Hai!