buildkite / test-collector-python

Python adapter for Buildkite Test Analytics
https://buildkite.com/test-analytics
MIT License
6 stars 5 forks source link

Add Collector name and version to Analytics API payload #13

Closed KatieWright26 closed 1 year ago

KatieWright26 commented 1 year ago

TA is working on displaying a tally of the types of collectors our customers are using. We can gather this data via the collector names and versions, however some collectors are missing this data (please see related linear ticket for list).

As I am unfamilar with python, I moved the NAME and VERSION values from the setup.py and defined them in a new file constants.py. This way we can share these values across file names while keeping them consistent. Happy to change if a Python speaker knows better!

This PR does not include the necessary version bump + publish to Python Package Index.

This collector will now emit the collector name "python-buildkite-test-collector"


Linear Ticket Related Linear Ticket

KatieWright26 commented 1 year ago

Code changes LGTM! I haven't tested or verified it works.

Can we update/add a test to verify the collector name and version is what we expect?

Maybe here (or another appropriate place)? https://github.com/buildkite/test-collector-python/blob/main/tests/buildkite_test_collector/collector/test_run_env.py#L32

Cool, have added - I really don't know how to test this as I also need to bump the package in another PR (I think). @swebb do you know?

jimsynz commented 1 year ago

Hi @KatieWright26. Good to see you! :)

KatieWright26 commented 1 year ago

Hi @KatieWright26. Good to see you! :)

Jimsy!! I saw your last name and couldn't remember if it was yours! Tiny NZ tech scene strikes again 😆