Not clear how to run tests

Bug #1836697 reported by Alexandre Gomes
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Glance-Simplestreams-Sync Charm
Fix Released
Low
Unassigned

Bug Description

I'm trying to contribute to this charm and running tests has been a little difficult. The commands in the Makefile are not relevant as unit tests can't be run with `tox -e py27` as indicated in tox.ini("#charm is NOT PY27 compatible") and the command for functional tests doesn't work as is.

It would be useful to have a CONTRIBUTING.md file with some clear information on to how run tests and what is expected when submitting merge proposals.

Revision history for this message
Frode Nordahl (fnordahl) wrote :

Thank you for your interest in contributing, and thank you for providing feedback!

This charm is a part of the OpenStack project and there are many fast moving parts. Counting charm and interface repositories there are over a hundred individual repositories. Having a complete contributor guide in each and every one of those repositories is not feasible.

We have collected shared information including how to contribute, what style of code we prefer and how to deploy the code in two shared documentation repositories [0][1].

There probably should be added a small snippet to point people to those though, and I believe we do so in all new repositories.

0: https://docs.openstack.org/charm-guide/latest/
1: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/

Frode Nordahl (fnordahl)
Changed in charm-glance-simplestreams-sync:
status: New → In Progress
importance: Undecided → Low
Revision history for this message
Frode Nordahl (fnordahl) wrote :
Revision history for this message
Tom Haddon (mthaddon) wrote :

https://docs.openstack.org/charm-guide/latest/testing.html seems to refer to things that don't work for this charm (`tox -e py27`), based on what the original reporter is saying, so sounds like it needs an exception to just linking to that documentation, fwiw.

Revision history for this message
Frode Nordahl (fnordahl) wrote :

I suspect ``tox -e py27`` no longer works for the bulk of our charms or OpenStack projects in general. We are moving to a Python3-only world.

So that specific detail of the charm guide might need an update.

Revision history for this message
Frode Nordahl (fnordahl) wrote :
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to charm-glance-simplestreams-sync (master)

Reviewed: https://review.opendev.org/670969
Committed: https://git.openstack.org/cgit/openstack/charm-glance-simplestreams-sync/commit/?id=801e602e0083e88706db7e7c010c67e18a561743
Submitter: Zuul
Branch: master

commit 801e602e0083e88706db7e7c010c67e18a561743
Author: Frode Nordahl <email address hidden>
Date: Tue Jul 16 09:42:57 2019 +0200

    Add doc pointing contributors to charm-guide

    Change-Id: Ie67344ec32cea4302e91e0809eaca4455f00e7e6
    Closes-Bug: #1836697

Changed in charm-glance-simplestreams-sync:
status: In Progress → Fix Committed
David Ames (thedac)
Changed in charm-glance-simplestreams-sync:
milestone: none → 19.10
David Ames (thedac)
Changed in charm-glance-simplestreams-sync:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.