OpenStack Shared File Systems Service (Manila)

ganesha: private attribute leaks to public API

Bug #1551497 reported by Csaba Henk on 2016-03-01

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	OpenStack Shared File Systems Service (Manila)	Fix Released	Low	Surya Ghatty	OpenStack Shared File Systems Service (Manila) mitaka-rc1 "RC1"

Bug Description

The manila.share.drivers.ganesha.GaneshaNASHelper class has a public attribute named confrx, see

http://docs.openstack.org/developer/manila/devref/ganesha.html#the-manila-share-drivers-ganesha-module

This is accidentally exposed, it should not be externally visible.

Surya Ghatty (ghatty) on 2016-03-01

Changed in manila:
assignee:	nobody → Surya Ghatty (ghatty)

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2016-03-02: Fix proposed to manila (master)

Fix proposed to branch: master
Review: https://review.openstack.org/287506

Changed in manila:
status:	New → In Progress

Revision history for this message

Surya Ghatty (ghatty) wrote on 2016-03-03:

Uploaded a patch.

The main goal of this bug fix is to remove unintended accidental exposure of the class variable confrx to public - either to the API or to the docs.

The root cause of this exposure was the way it was defined in the code. It should have been defined as _confrx instead of confrx as per the pep8 coding guidelines. The patch attempts to fix this issue.

One way to verify the fix is to look at the code itself, while making sure the variable does not appear in the docs is another.

Ran tox -e docs to build the docs and verified that _confrx does not show up in ganesha.html anymore.

Ben Swartzlander (bswartz) on 2016-03-03

Changed in manila:
importance:	Undecided → Low
milestone:	none → mitaka-rc1

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2016-03-04: Fix merged to manila (master)

Reviewed: https://review.openstack.org/287506
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=6a0bd8c5ad7d01b611220f25e2a1228e4d420945
Submitter: Jenkins
Branch: master

commit 6a0bd8c5ad7d01b611220f25e2a1228e4d420945
Author: Surya Ghatty <email address hidden>
Date: Wed Mar 2 23:06:19 2016 +0000

Remove unintended exposure of private attribute

GaneshaNASHelper has a class attribute confrx that is
currently coded up as a public variable. This was unintended.

    Made the following changes to fix this:
    1. The variable name was updated from confrx to _confrx
    per pep8 guidelines for defining non-public variables and instances.
    2. All references to this variable have been updated.

    Depends-On: Id7d43dee256856062bd0dadad9c469c1500ee36e
    Change-Id: Ie4fe96cd9cf9f0ea281c94f5c1378b255f60bada
    Co-Authored-By: Andrea Ma <email address hidden>
    Co-Authored-By: Andrei Ta <email address hidden>
    Co-Authored-By: Michael Rowden <email address hidden>
    Closes-Bug: #1551497