Support models with multi-level hierarchy (via roxspring) (#4503)

* Example of broken multi-level hierarchy

* Support for multiple levels of hierarchy in model objects

* Support for multiple levels of hierarchy in generators

* Regenerated samples

* Temporarily skip scalaz sample verification, which is having issue with Java version in CI container

* Re-enable scalaz in verify samples

Co-authored-by: Rob Oxspring <roxspring@imapmail.org>

samples/client/petstore/perl/README.md

@@ -245,6 +245,8 @@ use WWW::OpenAPIClient::Object::ApiResponse;
 use WWW::OpenAPIClient::Object::ArrayOfArrayOfNumberOnly;
 use WWW::OpenAPIClient::Object::ArrayOfNumberOnly;
 use WWW::OpenAPIClient::Object::ArrayTest;
+use WWW::OpenAPIClient::Object::BigCat;
+use WWW::OpenAPIClient::Object::BigCatAllOf;
 use WWW::OpenAPIClient::Object::Capitalization;
 use WWW::OpenAPIClient::Object::Cat;
 use WWW::OpenAPIClient::Object::CatAllOf;
@@ -310,6 +312,8 @@ use WWW::OpenAPIClient::Object::ApiResponse;
 use WWW::OpenAPIClient::Object::ArrayOfArrayOfNumberOnly;
 use WWW::OpenAPIClient::Object::ArrayOfNumberOnly;
 use WWW::OpenAPIClient::Object::ArrayTest;
+use WWW::OpenAPIClient::Object::BigCat;
+use WWW::OpenAPIClient::Object::BigCatAllOf;
 use WWW::OpenAPIClient::Object::Capitalization;
 use WWW::OpenAPIClient::Object::Cat;
 use WWW::OpenAPIClient::Object::CatAllOf;
@@ -422,6 +426,8 @@ Class | Method | HTTP request | Description
  - [WWW::OpenAPIClient::Object::ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md)
  - [WWW::OpenAPIClient::Object::ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md)
  - [WWW::OpenAPIClient::Object::ArrayTest](docs/ArrayTest.md)
+ - [WWW::OpenAPIClient::Object::BigCat](docs/BigCat.md)
+ - [WWW::OpenAPIClient::Object::BigCatAllOf](docs/BigCatAllOf.md)
  - [WWW::OpenAPIClient::Object::Capitalization](docs/Capitalization.md)
  - [WWW::OpenAPIClient::Object::Cat](docs/Cat.md)
  - [WWW::OpenAPIClient::Object::CatAllOf](docs/CatAllOf.md)

samples/client/petstore/perl/docs/BigCat.md

@@ -0,0 +1,15 @@
+# WWW::OpenAPIClient::Object::BigCat
+
+## Load the model package
+```perl
+use WWW::OpenAPIClient::Object::BigCat;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **string** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

samples/client/petstore/perl/docs/BigCatAllOf.md

@@ -0,0 +1,15 @@
+# WWW::OpenAPIClient::Object::BigCatAllOf
+
+## Load the model package
+```perl
+use WWW::OpenAPIClient::Object::BigCatAllOf;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **string** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

samples/client/petstore/perl/lib/WWW/OpenAPIClient/Object/BigCat.pm

@@ -0,0 +1,198 @@
+=begin comment
+
+OpenAPI Petstore
+
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end comment
+
+=cut
+
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# Do not edit the class manually.
+# Ref: https://openapi-generator.tech
+#
+package WWW::OpenAPIClient::Object::BigCat;
+
+require 5.6.0;
+use strict;
+use warnings;
+use utf8;
+use JSON qw(decode_json);
+use Data::Dumper;
+use Module::Runtime qw(use_module);
+use Log::Any qw($log);
+use Date::Parse;
+use DateTime;
+
+use WWW::OpenAPIClient::Object::BigCatAllOf;
+use WWW::OpenAPIClient::Object::Cat;
+
+use base ("Class::Accessor", "Class::Data::Inheritable", "WWW::OpenAPIClient::Object::Cat");
+
+#
+#
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). Do not edit the class manually.
+# REF: https://openapi-generator.tech
+#
+
+=begin comment
+
+OpenAPI Petstore
+
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end comment
+
+=cut
+
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# Do not edit the class manually.
+# Ref: https://openapi-generator.tech
+#
+__PACKAGE__->mk_classdata('attribute_map' => {});
+__PACKAGE__->mk_classdata('openapi_types' => {});
+__PACKAGE__->mk_classdata('method_documentation' => {}); 
+__PACKAGE__->mk_classdata('class_documentation' => {});
+
+# new plain object
+sub new { 
+    my ($class, %args) = @_; 
+
+    my $self = bless {}, $class;
+
+    $self->init(%args);
+    
+    return $self;
+}
+
+# initialize the object
+sub init
+{
+    my ($self, %args) = @_;
+
+    foreach my $attribute (keys %{$self->attribute_map}) {
+        my $args_key = $self->attribute_map->{$attribute};
+        $self->$attribute( $args{ $args_key } );
+    }
+
+    # initialize parent object Cat
+    $self->WWW::OpenAPIClient::Object::Cat::init(%args);
+}
+
+# return perl hash
+sub to_hash {
+    my $self = shift;
+    my $_hash = decode_json(JSON->new->convert_blessed->encode($self));
+
+    # call Cat to_hash and then combine hash
+    $_hash = { %$_hash, %$self->WWW::OpenAPIClient::Object::Cat::to_hash };
+
+    return $_hash;
+}
+
+# used by JSON for serialization
+sub TO_JSON { 
+    my $self = shift;
+    my $_data = {};
+    foreach my $_key (keys %{$self->attribute_map}) {
+        if (defined $self->{$_key}) {
+            $_data->{$self->attribute_map->{$_key}} = $self->{$_key};
+        }
+    }
+
+    # combine parent (Cat) TO_JSON
+    $_data = { %$_data, %$self->WWW::OpenAPIClient::Object::Cat::TO_JSON };
+
+    return $_data;
+}
+
+# from Perl hashref
+sub from_hash {
+    my ($self, $hash) = @_;
+
+    # loop through attributes and use openapi_types to deserialize the data
+    while ( my ($_key, $_type) = each %{$self->openapi_types} ) {
+        my $_json_attribute = $self->attribute_map->{$_key}; 
+        if ($_type =~ /^array\[(.+)\]$/i) { # array
+            my $_subclass = $1;
+            my @_array = ();
+            foreach my $_element (@{$hash->{$_json_attribute}}) {
+                push @_array, $self->_deserialize($_subclass, $_element);
+            }
+            $self->{$_key} = \@_array;
+        } elsif ($_type =~ /^hash\[string,(.+)\]$/i) { # hash
+            my $_subclass = $1;
+            my %_hash = ();
+            while (my($_key, $_element) = each %{$hash->{$_json_attribute}}) {
+                $_hash{$_key} = $self->_deserialize($_subclass, $_element);
+            }
+            $self->{$_key} = \%_hash;
+        } elsif (exists $hash->{$_json_attribute}) { #hash(model), primitive, datetime
+            $self->{$_key} = $self->_deserialize($_type, $hash->{$_json_attribute});
+        } else {
+            $log->debugf("Warning: %s (%s) does not exist in input hash\n", $_key, $_json_attribute);
+        }
+    }
+
+    # call parent (Cat) from_hash
+    $self->WWW::OpenAPIClient::Object::Cat::from_hash($hash);
+  
+    return $self;
+}
+
+# deserialize non-array data
+sub _deserialize {
+    my ($self, $type, $data) = @_;
+    $log->debugf("deserializing %s with %s",Dumper($data), $type);
+
+    if ($type eq 'DateTime') {
+        return DateTime->from_epoch(epoch => str2time($data));
+    } elsif ( grep( /^$type$/, ('int', 'double', 'string', 'boolean'))) {
+        return $data;
+    } else { # hash(model)
+        my $_instance = eval "WWW::OpenAPIClient::Object::$type->new()";
+        return $_instance->from_hash($data);
+    }
+}
+
+
+
+__PACKAGE__->class_documentation({description => '',
+                                  class => 'BigCat',
+                                  required => [], # TODO
+}                                 );
+
+__PACKAGE__->method_documentation({
+    'kind' => {
+        datatype => 'string',
+        base_name => 'kind',
+        description => '',
+        format => '',
+        read_only => '',
+            },
+});
+
+__PACKAGE__->openapi_types( {
+    'kind' => 'string'
+} );
+
+__PACKAGE__->attribute_map( {
+    'kind' => 'kind'
+} );
+
+__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
+
+
+1;

samples/client/petstore/perl/lib/WWW/OpenAPIClient/Object/BigCatAllOf.pm

@@ -0,0 +1,184 @@
+=begin comment
+
+OpenAPI Petstore
+
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end comment
+
+=cut
+
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# Do not edit the class manually.
+# Ref: https://openapi-generator.tech
+#
+package WWW::OpenAPIClient::Object::BigCatAllOf;
+
+require 5.6.0;
+use strict;
+use warnings;
+use utf8;
+use JSON qw(decode_json);
+use Data::Dumper;
+use Module::Runtime qw(use_module);
+use Log::Any qw($log);
+use Date::Parse;
+use DateTime;
+
+
+use base ("Class::Accessor", "Class::Data::Inheritable");
+
+#
+#
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). Do not edit the class manually.
+# REF: https://openapi-generator.tech
+#
+
+=begin comment
+
+OpenAPI Petstore
+
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end comment
+
+=cut
+
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# Do not edit the class manually.
+# Ref: https://openapi-generator.tech
+#
+__PACKAGE__->mk_classdata('attribute_map' => {});
+__PACKAGE__->mk_classdata('openapi_types' => {});
+__PACKAGE__->mk_classdata('method_documentation' => {}); 
+__PACKAGE__->mk_classdata('class_documentation' => {});
+
+# new plain object
+sub new { 
+    my ($class, %args) = @_; 
+
+    my $self = bless {}, $class;
+
+    $self->init(%args);
+    
+    return $self;
+}
+
+# initialize the object
+sub init
+{
+    my ($self, %args) = @_;
+
+    foreach my $attribute (keys %{$self->attribute_map}) {
+        my $args_key = $self->attribute_map->{$attribute};
+        $self->$attribute( $args{ $args_key } );
+    }
+}
+
+# return perl hash
+sub to_hash {
+    my $self = shift;
+    my $_hash = decode_json(JSON->new->convert_blessed->encode($self));
+
+    return $_hash;
+}
+
+# used by JSON for serialization
+sub TO_JSON { 
+    my $self = shift;
+    my $_data = {};
+    foreach my $_key (keys %{$self->attribute_map}) {
+        if (defined $self->{$_key}) {
+            $_data->{$self->attribute_map->{$_key}} = $self->{$_key};
+        }
+    }
+
+    return $_data;
+}
+
+# from Perl hashref
+sub from_hash {
+    my ($self, $hash) = @_;
+
+    # loop through attributes and use openapi_types to deserialize the data
+    while ( my ($_key, $_type) = each %{$self->openapi_types} ) {
+        my $_json_attribute = $self->attribute_map->{$_key}; 
+        if ($_type =~ /^array\[(.+)\]$/i) { # array
+            my $_subclass = $1;
+            my @_array = ();
+            foreach my $_element (@{$hash->{$_json_attribute}}) {
+                push @_array, $self->_deserialize($_subclass, $_element);
+            }
+            $self->{$_key} = \@_array;
+        } elsif ($_type =~ /^hash\[string,(.+)\]$/i) { # hash
+            my $_subclass = $1;
+            my %_hash = ();
+            while (my($_key, $_element) = each %{$hash->{$_json_attribute}}) {
+                $_hash{$_key} = $self->_deserialize($_subclass, $_element);
+            }
+            $self->{$_key} = \%_hash;
+        } elsif (exists $hash->{$_json_attribute}) { #hash(model), primitive, datetime
+            $self->{$_key} = $self->_deserialize($_type, $hash->{$_json_attribute});
+        } else {
+            $log->debugf("Warning: %s (%s) does not exist in input hash\n", $_key, $_json_attribute);
+        }
+    }
+  
+    return $self;
+}
+
+# deserialize non-array data
+sub _deserialize {
+    my ($self, $type, $data) = @_;
+    $log->debugf("deserializing %s with %s",Dumper($data), $type);
+
+    if ($type eq 'DateTime') {
+        return DateTime->from_epoch(epoch => str2time($data));
+    } elsif ( grep( /^$type$/, ('int', 'double', 'string', 'boolean'))) {
+        return $data;
+    } else { # hash(model)
+        my $_instance = eval "WWW::OpenAPIClient::Object::$type->new()";
+        return $_instance->from_hash($data);
+    }
+}
+
+
+
+__PACKAGE__->class_documentation({description => '',
+                                  class => 'BigCatAllOf',
+                                  required => [], # TODO
+}                                 );
+
+__PACKAGE__->method_documentation({
+    'kind' => {
+        datatype => 'string',
+        base_name => 'kind',
+        description => '',
+        format => '',
+        read_only => '',
+            },
+});
+
+__PACKAGE__->openapi_types( {
+    'kind' => 'string'
+} );
+
+__PACKAGE__->attribute_map( {
+    'kind' => 'kind'
+} );
+
+__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
+
+
+1;

samples/client/petstore/perl/t/BigCatAllOfTest.t

@@ -0,0 +1,33 @@
+=begin comment
+
+OpenAPI Petstore
+
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end comment
+
+=cut
+
+#
+# NOTE: This class is auto generated by the OpenAPI Generator
+# Please update the test cases below to test the model.
+# Ref: https://openapi-generator.tech
+#
+use Test::More tests => 2;
+use Test::Exception;
+
+use lib 'lib';
+use strict;
+use warnings;
+
+
+use_ok('WWW::OpenAPIClient::Object::BigCatAllOf');
+
+my $instance = WWW::OpenAPIClient::Object::BigCatAllOf->new();
+
+isa_ok($instance, 'WWW::OpenAPIClient::Object::BigCatAllOf');
+

samples/client/petstore/perl/t/BigCatTest.t

@@ -0,0 +1,33 @@
+=begin comment
+
+OpenAPI Petstore
+
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end comment
+
+=cut
+
+#
+# NOTE: This class is auto generated by the OpenAPI Generator
+# Please update the test cases below to test the model.
+# Ref: https://openapi-generator.tech
+#
+use Test::More tests => 2;
+use Test::Exception;
+
+use lib 'lib';
+use strict;
+use warnings;
+
+
+use_ok('WWW::OpenAPIClient::Object::BigCat');
+
+my $instance = WWW::OpenAPIClient::Object::BigCat->new();
+
+isa_ok($instance, 'WWW::OpenAPIClient::Object::BigCat');
+