atlasdb icon indicating copy to clipboard operation
atlasdb copied to clipboard

Refactor to improve CassandaraService test coverage

Open schlosna opened this issue 2 years ago • 1 comments

General

Before this PR: The unit test coverage for CassandraService was suboptimal, not catching a potential break in https://github.com/palantir/atlasdb/pull/6074 and did not simulate various cases when Cassandra cluster resizes or encounters various partial failure modes.

Additionally, the CassandraServiceTest can be quite slow locally and in CI as it must wait for non-existent nodes to timeout, where as we can inject and control the node & address mappings for our test simulations and speed these up.

After this PR: Follow up to https://github.com/palantir/atlasdb/pull/6207 to improve the CassandraService test coverage and CassandraServiceTest now runs ~7x faster compared to develop.

==COMMIT_MSG== Refactor to improve CassandaraService test coverage ==COMMIT_MSG==

Priority: P1

Concerns / possible downsides (what feedback would you like?): There are a wide variety of Cassandra rolling restart, partial failure, recovery, and other degraded modes that we don't currently unit test here. I was not planning on building out those additional cases right now given other constraints, but wanted to improve state of the world.

Is documentation needed?: no

Compatibility

Does this PR create any API breaks (e.g. at the Java or HTTP layers) - if so, do we have compatibility?:

Does this PR change the persisted format of any data - if so, do we have forward and backward compatibility?:

The code in this PR may be part of a blue-green deploy. Can upgrades from previous versions safely coexist? (Consider restarts of blue or green nodes.):

Does this PR rely on statements being true about other products at a deployment - if so, do we have correct product dependencies on these products (or other ways of verifying that these statements are true)?:

Does this PR need a schema migration?

Testing and Correctness

What, if any, assumptions are made about the current state of the world? If they change over time, how will we find out?:

What was existing testing like? What have you done to improve it?:

If this PR contains complex concurrent or asynchronous code, is it correct? The onus is on the PR writer to demonstrate this.:

If this PR involves acquiring locks or other shared resources, how do we ensure that these are always released?:

Execution

How would I tell this PR works in production? (Metrics, logs, etc.):

Has the safety of all log arguments been decided correctly?:

Will this change significantly affect our spending on metrics or logs?:

How would I tell that this PR does not work in production? (monitors, etc.):

If this PR does not work as expected, how do I fix that state? Would rollback be straightforward?:

If the above plan is more complex than “recall and rollback”, please tag the support PoC here (if it is the end of the week, tag both the current and next PoC):

Scale

Would this PR be expected to pose a risk at scale? Think of the shopping product at our largest stack.:

Would this PR be expected to perform a large number of database calls, and/or expensive database calls (e.g., row range scans, concurrent CAS)?:

Would this PR ever, with time and scale, become the wrong thing to do - and if so, how would we know that we need to do something differently?:

Development Process

Where should we start reviewing?:

If this PR is in excess of 500 lines excluding versions lock-files, why does it not make sense to split it?:

Please tag any other people who should be aware of this PR: @jeremyk-91 @sverma30 @raiju

schlosna avatar Sep 08 '22 16:09 schlosna

Generate changelog in changelog/@unreleased

Type

  • [ ] Feature
  • [x] Improvement
  • [ ] Fix
  • [ ] Break
  • [ ] Deprecation
  • [ ] Manual task
  • [ ] Migration

Description Refactor to improve CassandaraService test coverage

Check the box to generate changelog(s)

  • [x] Generate changelog entry

changelog-app[bot] avatar Sep 08 '22 16:09 changelog-app[bot]

closing for now

schlosna avatar Dec 01 '22 15:12 schlosna