File Coverage

blib/lib/Ovirt/Template.pm

Criterion	Covered	Total	%
statement	9	111	8.1
branch	0	90	0.0
condition	0	20	0.0
subroutine	3	8	37.5
pod			n/a
total	12	229	5.2

package Ovirt::Template;

use v5.10;
use Carp;
use Moo;

with 'Ovirt';
our $VERSION = '0.01';

=head1 NAME

Ovirt::Template - Bindings for oVirt Template API

=head1 VERSION

Version 0.01

=cut

=head1 SYNOPSIS

 use Ovirt::Template;

 my %con = (
            username                => 'admin',
            password                => 'password',
            manager                 => 'ovirt-mgr.example.com',
            template_output_attrs   => 'id,name,type,description', # optional
 );

 my $template = Ovirt::Template->new(%con);

 # return xml output
 print $template->list_xml;

 # list template attributes
 print $template->list;

 # the output also available in hash
 # for example to print all template name
 my $hash = $template->hash_output;
 for my $array (keys $hash->{template}) {
    print $hash->{template}[$array]->{name};
 }

 # we can also specify specific template 'id' when initiating an object
 # so we can direct access the element for specific template
 print $template->hash_output->{id};
 print $template->hash_output->{name};

=head1 Attributes

 Other attributes is also inherited from Ovirt.pm
 Check 'perldoc Ovirt' for detail

 notes :
 ro                     = read only, can be specified only during initialization
 rw                     = read write, user can set this attribute
 rwp                    = read write protected, for internal class

 template_url            = (ro) store default template url path
 template_output_attrs   = (rw) store template attributes to be returned, default is (id, name, description)
                          supported attributes :
                            id          name
                            type        description
                            state       memory
                            cpu_sockets cpu_arch
                            cpu_cores   creation_time
                            cpu_shares  os_type
                            boot_dev    ha_enabled
                            ha_priority display_type
                            cluster_id  usb_enabled

 template_output_delimiter    = (rw) specify output delimiter between attribute, default is '||'
=cut

has 'template_url'              => ( is => 'ro', default => '/api/templates' );
has 'template_output_attrs'     => ( is => 'rw', default => 'id,name,description',
                                 isa => sub {
                                     # store all output attribute into array split by ','
                                     # $_[0] is the arguments spefied during initialization
                                     my @attrs = split ',' => $_[0];

                                     croak "template_output_attrs can't be empty"
                                        unless @attrs;

                                     # check if provided attribute is valid / supported
                                     my @supported_attr = qw |
                                                                id          name
                                                                type        description
                                                                state       memory
                                                                cpu_sockets cpu_arch
                                                                cpu_cores   creation_time
                                                                cpu_shares  os_type
                                                                boot_dev    ha_enabled
                                                                ha_priority display_type
                                                                cluster_id  usb_enabled
                                                            |;
                                     for my $attr (@attrs) {
                                         $attr = lc ($attr);
                                         $attr = Ovirt->trim($attr);
                                         croak "Attribute $attr is not valid / supported"
                                            unless grep { /\b$attr\b/ } @supported_attr;
                                     }
                                 });

has 'template_output_delimiter'   => ( is => 'rw', default => '||' );

=head1 SUBROUTINES/METHODS

=head2 BUILD

 The Constructor, build logging, call pass_log_obj method
 Built root_url with template_url
 set output with get_api_response method from Ovirt.pm
=cut

sub BUILD {
    my $self = shift;

    $self->pass_log_obj;

    if ($self->id) {
        $self->_set_root_url($self->template_url. '/' . $self->id);
    }
    else {
        $self->_set_root_url($self->template_url);
    }

    $self->get_api_response();
}

=head2 list_xml

 return xml output
=cut

sub list_xml {
    my $self = shift;

    return $self->xml_output;
}

=head2 list

 return template's attributes text output from hash_output attribute
 if no argument spesified, it will return all template attributes (based on template_output_attrs)
 argument supported is 'template id'
 example :
 $template->list('c4738b0f-b73d-4a66-baa8-2ba465d63132');
=cut

sub list {
    my $self = shift;

    my $templateid = shift || undef;

    # store the output and return it at the end
    my $output;

    # store each attribute to array to be looped
    my @attrs   = split ',' => $self->template_output_attrs;

    # store the last element to escape the template_output_delimeter
    my $last_element = pop (@attrs);
    $self->log->debug("last element = $last_element");

    # if the id is defined during initialization
    # the rest api output will only contain attributes for this id
    # so it's not necessary to loop on template element
    if ($self->id) {
        for my $attr (@attrs) {
            $self->log->debug("requesting attribute $attr");

            my $attr_output = $self->get_template_by_self_id($attr) || $self->not_available;
            $output         .= $attr_output . $self->template_output_delimiter;
            $self->log->debug("output for attribute $attr  = " . $attr_output);
        }

        #handle last element or the only element
        $self->log->debug("requesting attribute $last_element");

        if (my $last_output = $self->get_template_by_self_id($last_element) || $self->not_available) {
            $output .= $last_output;
            $self->log->debug("output for attribute $last_element  = " . $last_output);
        }

        $output .= "\n";
    }
    elsif ($templateid) {
        #store templateid element
        my $templateid_element;

        $templateid = $self->trim($templateid);

        for my $element_id ( 0 .. $#{ $self->hash_output->{template} } ) {
            next unless $self->hash_output->{template}[$element_id]->{id} eq $templateid;

            $templateid_element = $element_id;
        }

        croak "template id not found" unless $templateid_element >= 0;

        for my $attr (@attrs) {
           $self->log->debug("requesting attribute $attr for element $templateid_element");

            my $attr_output = $self->get_template_by_element_id($templateid_element, $attr) || $self->not_available;
            $output         .= $attr_output . $self->template_output_delimiter;
            $self->log->debug("output for attribute $attr element $templateid_element = " . $attr_output);
        }

        #handle last element or the only element
        $self->log->debug("requesting attribute $last_element for element $templateid_element");

        if (my $last_output = $self->get_template_by_element_id($templateid_element, $last_element) || $self->not_available) {
            $output .= $last_output;
            $self->log->debug("output for attribute $last_element element $templateid_element = " . $last_output);
        }

        $output .= "\n";
    }
    else {

        for my $element_id ( 0 .. $#{ $self->hash_output->{template} } ) {

            # in case there's no any element left, the last element become the only attribute requested
            if (@attrs) {
                for my $attr (@attrs) {

                    $self->log->debug("requesting attribute $attr for element $element_id");

                    my $attr_output = $self->get_template_by_element_id($element_id, $attr) || $self->not_available;
                    $output         .= $attr_output . $self->template_output_delimiter;
                    $self->log->debug("output for attribute $attr element $element_id = " . $attr_output);
                }
            }

            #handle last element or the only element
            $self->log->debug("requesting attribute $last_element for element $element_id");

            if (my $last_output = $self->get_template_by_element_id($element_id, $last_element) || $self->not_available) {
                $output .= $last_output;
                $self->log->debug("output for attribute $last_element element $element_id = " . $last_output);
            }

            $output .= "\n";
        }
    }

    return $output;
}

=head2 get_template_by_element_id

 This method is used by list method to list all template attributes requested
 An array element id and attribute name is required
=cut

sub get_template_by_element_id {
    my $self = shift;

    my ($element_id, $attr) = @_;

    croak "hash output is not defined"
        unless $self->hash_output;

    $attr = $self->trim($attr);
    $self->log->debug("element id = $element_id, attribute = $attr");

    if      ($attr eq 'id') {
            return $self->hash_output->{template}[$element_id]->{id};
    }
    elsif   ($attr eq 'name') {
            return $self->hash_output->{template}[$element_id]->{name};
    }
    elsif   ($attr eq 'memory') {
            return $self->hash_output->{template}[$element_id]->{memory};
    }
    elsif   ($attr eq 'type') {
            return $self->hash_output->{template}[$element_id]->{type};
    }
    elsif   ($attr eq 'state') {
            return $self->hash_output->{template}[$element_id]->{status}->{state};
    }
    elsif   ($attr eq 'description') {
            return $self->hash_output->{template}[$element_id]->{description};
    }
    elsif   ($attr eq 'cpu_cores') {
            return $self->hash_output->{template}[$element_id]->{cpu}->{topology}->{cores};
    }
    elsif   ($attr eq 'cpu_sockets') {
            return $self->hash_output->{template}[$element_id]->{cpu}->{topology}->{sockets};
    }
    elsif   ($attr eq 'cpu_arch') {
            return $self->hash_output->{template}[$element_id]->{cpu}->{architecture};
    }
    elsif   ($attr eq 'cpu_shares') {
            return $self->hash_output->{template}[$element_id]->{cpu_shares};
    }
    elsif   ($attr eq 'os_type') {
            return $self->hash_output->{template}[$element_id]->{os}->{type};
    }
    elsif   ($attr eq 'boot_dev') {
            return $self->hash_output->{template}[$element_id]->{os}->{boot}->{dev};
    }
    elsif   ($attr eq 'ha_enabled') {
            return $self->hash_output->{template}[$element_id]->{high_availability}->{enabled};
    }
    elsif   ($attr eq 'ha_priority') {
            return $self->hash_output->{template}[$element_id]->{high_availability}->{priority};
    }
    elsif   ($attr eq 'display_type') {
            return $self->hash_output->{template}[$element_id]->{display}->{type};
    }
    elsif   ($attr eq 'cluster_id') {
            return $self->hash_output->{template}[$element_id]->{cluster}->{id};
    }
    elsif   ($attr eq 'creation_time') {
            return $self->hash_output->{template}[$element_id]->{creation_time};
    }
    elsif   ($attr eq 'usb_enabled') {
            return $self->hash_output->{template}[$element_id]->{usb}->{enabled};
    }
}

=head2 get_template_by_self_id

 This method is used by list method if $self->id is defined
 The id is set during initialization (id => 'templateid')
 attribute name is required
=cut

sub get_template_by_self_id {
    my $self = shift;

    my $attr = shift;

    croak "hash output is not defined"
        unless $self->hash_output;

    $attr = $self->trim($attr);
    $self->log->debug("attribute = $attr");

    if      ($attr eq 'id') {
            return $self->hash_output->{id};
    }
    elsif   ($attr eq 'name') {
            return $self->hash_output->{name};
    }
    elsif   ($attr eq 'state') {
            return $self->hash_output->{status}->{state};
    }
    elsif   ($attr eq 'description') {
            return $self->hash_output->{description};
    }
    elsif   ($attr eq 'cpu_cores') {
            return $self->hash_output->{cpu}->{topology}->{cores};
    }
    elsif   ($attr eq 'cpu_sockets') {
            return $self->hash_output->{cpu}->{topology}->{sockets};
    }
    elsif   ($attr eq 'cpu_arch') {
            return $self->hash_output->{cpu}->{architecture};
    }
    elsif   ($attr eq 'cpu_shares') {
            return $self->hash_output->{cpu_shares};
    }
    elsif   ($attr eq 'os_type') {
            return $self->hash_output->{os}->{type};
    }
    elsif   ($attr eq 'boot_dev') {
            return $self->hash_output->{os}->{boot}->{dev};
    }
    elsif   ($attr eq 'ha_enabled') {
            return $self->hash_output->{high_availability}->{enabled};
    }
    elsif   ($attr eq 'ha_priority') {
            return $self->hash_output->{high_availability}->{priority};
    }
    elsif   ($attr eq 'display_type') {
            return $self->hash_output->{display}->{type};
    }
    elsif   ($attr eq 'cluster_id') {
            return $self->hash_output->{cluster}->{id};
    }
    elsif   ($attr eq 'creation_time') {
            return $self->hash_output->{creation_time};
    }
    elsif   ($attr eq 'usb_enabled') {
            return $self->hash_output->{usb}->{enabled};
    }
}

=head1 AUTHOR

 "Heince Kurniawan", C<< <"heince at cpan.org"> >>

=head1 BUGS

 Please report any bugs or feature requests to C, or through
 the web interface at L.  I will be notified, and then you'll
 automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

 You can find documentation for this module with the perldoc command.

    perldoc Ovirt::Template

 You can also look for information at:

=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2015 "Heince Kurniawan".

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


=cut

1;