mengesb / gglib Goto Github PK

There are several methods with optional or required parameters that need to be validated against commonlookuplist().

Example:

    def gridimageedit(self,          params={}):
        """https://wiki.gogrid.com/index.php/API:grid.image.edit

        RBAC: Super User, System User

        Required (ONLY ONE of the following)
            - id             : The ID of the image to edit.
                               Valid values: regex(^[0-9]+$)
                               Type: string
            - name           : The name of the image to edit.
                               Valid values: regex(^GSI-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{8}$)
                               Type: string
            - image          : The ID or name of the image to edit.
                               Type: string
        Optional
            - friendlyName   : The edited friendly name of the image.
                               Type: string
            - description    : The edited descriptive text to describe this image.
                               Type: string
            - isPublic       : Will the image will be visible to the entire GoGrid community?
                               Type: boolean
            - image.minram   : Set the minimum ram value.
                               Valid values: commonlookuplist() with 'lookup' set to 'image.minram'
                               Type: string
            - image.type     : The ID or name of the server type.
                               Valid values: commonlookuplist() with 'lookup' set to 'image.type'
                               Type: string
        """

Above we see that image.minram and image.type have specific valid values that can be obtained from commonlookuplist(). We should fetch the valid values, and compare against the valid values fetched to ensure we're providing a valid parameter value for anything using commonlookuplist()

Items to be investigated:

• datacenter on global class
• image.minram on gridimageedit
• image.type on gridimageedit/gridimagelist/gridimagesave
• image.state on gridimagelist
• ip.state on gridiplist
• ip.type on gridiplist
• job.objecttype on gridjoblist
• job.state on gridjoblist
• loadbalancer.type on gridloadbalanceradd
• loadbalancer.persistence on gridloadbalanceradd
• server.ram on gridserveradd/gridserveredit
• server.type on gridserveredit/gridserverlist
• datacenter on gridloadbalancerlist - lookup loadbalancer.datacenter

There are some value constraints for some keys in various places, such as validating an IP (which could also be validated against lookup), or string limitations (must start with [a-zA-Z] and <= 20 [a-zA-Z0-9\ ] characters.

These constraints should be applied and warnings emitted where applicable.

Need to write tests against all methds

The whole code style, syntax, and style needs to be proof read through and through.

Ensure:

• Same style is applied to ALL methods
• Same logging level of information applied to ALL methods
• Reasonably sane sentences (brief and possibly broken, but point made AND understood)