Add support for next_query_flagIN

[ls-michielrensen]

SUMMARY

This PR adds support for next_query_flagIN in the proxysql_query_rules plugin

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

proxysql_query_rules

ADDITIONAL INFORMATION

next_query_flagIN allows to chain query rules which is useful for when example you want to allow a SELECT after an INSERT/UPDATE/DELETE to run on the same hostgroup (avoiding replication lag).

- name: Add insert query rule
   proxysql_query_rules:
      match_digest: "^INSERT"
      destination_hostgroup: 1,
      next_query_flagIN: 1

- name: Add update query rule
   proxysql_query_rules:
      match_digest: "^UPDATE"
      destination_hostgroup: 1,
      next_query_flagIN: 1

- name: Add delete query rules
   proxysql_query_rules:
      match_digest: "^DELETE"
      destination_hostgroup: 1,
      next_query_flagIN: 1

- name: Add insert query rules
   proxysql_query_rules:
      match_digest: ".*"
      destination_hostgroup: 1,
      next_query_flagIN: 1
      comment: Match every queries after an INSERT/UPDATE/DELETE query

[markuman]

version added would be 1.3.0.
can you also please add a changelog fragement @ls-michielrensen?

futhermore I'm afraid that this will break backwards compatibility with proxysql 1.x.x like #71 #73

[ls-michielrensen]

Yeah it probably is not backwards compatible no, do we need to add a version constraint somewhere?

[markuman]

basically you can adopt like this: ca47c32
This is imo sufficient. The integration test must be updated/prepared. I'm working on that already in #73

[Andersson007]

link to the changelog related doc for convenience https://docs.ansible.com/ansible/latest/community/development_process.html#creating-a-changelog-fragment

[Andersson007]

@ls-michielrensen thanks for the PR!

I'm abstain from evaluating this changes as I'm not a specialist.

@markuman knows better:)

I would also add:

1. Example to the EXAMPLES block
2. Integration tests
3. Changelog fragment as @markuman spotted
4. Mention in the options descriptions that they are supported since ProxySQL version ..., otherwise they should be ignored or the module should fail. Not sure which approach is better

[ls-michielrensen]

@ls-michielrensen thanks for the PR!

I'm abstain from evaluating this changes as I'm not a specialist.

@markuman knows better:)

I would also add:

1. Example to the EXAMPLES blocks

Added the example from this PR description to the block

2. Integration tests

Uh gotta figure that out (first-timer here...)

3. Changelog fragment as @markuman spotted

Changelog fragment added

4. Mention in the options descriptions that they are supported since ProxySQL version ..., otherwise they should be ignored or the module should fail. Not sure which approach is better

Added version constraint as suggested by @markuman in ca47c32

[ls-michielrensen]

@markuman Your suggestion to add version constraints seemed to have broken the Integration tests. I guess we'll have to figure that out some other way...

[markuman]

@markuman Your suggestion to add version constraints seemed to have broken the Integration tests. I guess we'll have to figure that out some other way...

No, there is something failing that is not affected by your PR

TASK [test_proxysql_replication_hostgroups : verify idempotent - change for proxysql >= 2] ***

However, as mentioned above, you can revert it, because the table also exists in 1.4.15. It was my fault.

[markuman]

I see two sanity erros locally

ERROR: plugins/modules/proxysql_query_rules.py:268:82: W291: trailing whitespace
ERROR: plugins/modules/proxysql_query_rules.py:273:24: invalid-examples: EXAMPLES is not valid YAML

[ls-michielrensen]

@markuman thanks, fixed the sanity failures, silly mistake on my end. Also reverted the version constraint 👍🏻

[markuman]

Integration test pass locally for test_proxysql_query_rules.
Last missing peace is to append the existing integration test and test the new parameters (add/modify in check_mode, not in check_mode and idempotent).

[ls-michielrensen]

@markuman thanks for double checking. Can you point me in the right direction as to how to run the integration tests locally?

[Andersson007]

@ls-michielrensen you could use this tutorial https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst#test-your-changes

[ls-michielrensen]

@Andersson007 thanks for the headsup, worked flawlessly 👍🏻
@markuman I amended the integration tests to include next_query_flagIN. The tests are passing for me locally 👍🏻

[markuman]

LGTM

[Andersson007]

LGTM from general perspective:)

[Andersson007]

@ls-michielrensen thanks for the contribution! @markuman thanks for reviewing and merging!

[ls-michielrensen]

@Andersson007 you're welcome, was a fun experience and quickly executed 👍🏻