File Coverage

blib/lib/OcToolkit.pm

Criterion	Covered	Total	%
statement	50	588	8.5
branch	0	254	0.0
condition	0	73	0.0
subroutine	17	49	34.6
pod	6	11	54.5
total	73	975	7.4

# John Summers,  hereby disclaims all copyright interest in the program Open Cloud Toolkit aka "ocToolkit"  written by John Summers
#
# John Summers, [e-mail]
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see .

package OcToolkit;

use v5.16; # or newer
use strict;
use warnings;

our $VERSION = "1.14";

use JSON::PP;
use Tie::IxHash;
use Text::Diff;
use Template;
use File::Slurp;
use File::Find::Rule;
use File::Path qw(make_path rmtree);
use MIME::Base64 qw(encode_base64 decode_base64);
use YAML qw(LoadFile);
use YAML::Safe;

use Data::Dumper;


sub new{
    my $class = shift;
    my $self  = {@_};

    $self->{tt}   = Template->new({INTERPOLATE  => 1, ABSOLUTE => 1});
    $self->{json} = JSON::PP->new;
    $self->{json}->convert_blessed();

    my $projectDir = $self->{projectDir}; # e.g.: /home/user/myProject/

    $self->{secretsDir}           = $projectDir."secrets"               if not defined $self->{secretsDir};
    $self->{secretsJson}          = "secrets.json"                      if not defined $self->{secretsJson};
    $self->{ocConfigFile}         = $projectDir."oc_config.json"        if not defined $self->{ocConfigFile};
    $self->{templatesTTDir}       = $projectDir."templates_tt"          if not defined $self->{templatesTTDir};
    $self->{templatesYamlDir}     = $projectDir."templates_yaml"        if not defined $self->{templatesYamlDir};
    $self->{validationReportFile} = $projectDir."validation_report.txt" if not defined $self->{validationReportFile};
    $self->{cliCommand}           = "oc"                                if not defined $self->{cloudCommand};
    if((defined $self->{advanceFeatures}) && ($self->{advanceFeatures} =~ /kubectl/)){
         $self->{cliCommand} = "kubectl";
    }

    if(!-e $self->{ocConfigFile}){
        open(my $fh, '>', $self->{ocConfigFile}) or die "Could not create '$self->{ocConfigFile}': $!";
        print $fh '{}';
        close($fh);
        print "$self->{ocConfigFile} is missing. Empty $self->{ocConfigFile} is created.\n";
    }

    if(not defined $self->{cluster}){
        my $ocConfigFiletext = read_file($self->{ocConfigFile});
        my $oCconfig = $self->{json}->utf8->decode($ocConfigFiletext);
        $self->{cluster} = $oCconfig->{project}->{default_cluster};
        $self->{cluster} = "unknown" if not defined $self->{cluster};
    }

    return bless $self, $class;
}

sub backup{
    my ($self, $instance) = @_;

    $self->{instance} = $instance;
    return if not defined $self->generateYaml();

    $self->_createDir("backups");
    $self->_createDir("backups\/$instance");

    $self->_loopDir($self->{config}->{templates_yaml_dir}, "*", "_backupInstance");
}

sub backupWholeOCProject{
    my ($self) = @_;

    $self->_createDir("backups");
    $self->_createDir("backups\/wholeProject");
    $self->_clearDir("backups/wholeProject");

    my $ocConfigFileText = read_file($self->{ocConfigFile});
    my $ocConfig = $self->{json}->utf8->decode($ocConfigFileText);

    my $ocResourceKinds = $ocConfig->{project}->{oc_resource_kinds};
    $ocResourceKinds = $self->{ocResourceKinds} if defined $self->{ocResourceKinds};
    $ocResourceKinds = $self->_getDefaultKinds() if not defined $ocResourceKinds;
    my @ocResourceKindsArray = split(';', $ocResourceKinds);

    foreach my $ocResourceKind (@ocResourceKindsArray){
        my $ocResourceKinds = $ocResourceKind;
        if($ocResourceKind ne "Ingress" &&
           $ocResourceKind ne "StorageClass" &&
           $ocResourceKind ne "NetworkPolicy"
        ){
            $ocResourceKinds .= "s";
        }
        print "$ocResourceKinds:\n";
        my $text = qx/$self->{cliCommand} get $ocResourceKinds/;
        my @textArray = split('\n', $text);
        shift @textArray;
        foreach my $line (@textArray){
            my @lineArray = split(" ", $line);
            my $ocItem = $lineArray[0];
            print "kind: $ocResourceKind  item: $ocItem\n";
            $self->_createDir("backups\/wholeProject\/$ocResourceKinds");
            eval {
                my $ocItemJson = qx/$self->{cliCommand} get $ocResourceKind $ocItem -o json/;
                my $ocItemHash = $self->{json}->utf8->decode($ocItemJson);
                if((defined $self->{advanceFeatures}) &&
                   ($self->{advanceFeatures} =~ /removeClutter/) &&
                   (defined $self->{removeClutterBackup})){
                    my $subParams = {"ocKind" => $ocResourceKind, "ocName" => $ocItem};
                    $ocItemHash = $self->{removeClutterBackup}->($ocItemHash, $subParams);
                }
                my $yamlSaveObj = YAML::Safe->new->boolean("JSON::PP");
                my $yamlText = $yamlSaveObj->Dump($ocItemHash);
                $yamlText =~ s/---\n//;
                write_file("$self->{projectDir}backups\/wholeProject\/$ocResourceKinds/$ocItem".".yaml", $yamlText);
            };
            if($@){
                # if error occured take yaml without calling '->removeClutterBackup()'
                print "Removing clutter has failed, writing yaml file: $ocResourceKinds/$ocItem.yaml without removing clutter.\n";
                my $yamlText = qx/$self->{cliCommand} get $ocResourceKind $ocItem -o yaml/;
                write_file("$self->{projectDir}backups\/wholeProject\/$ocResourceKinds/$ocItem".".yaml", $yamlText);
            }
        }
    }
}

sub convertYamlToTTExtention{
    my ($self, $yamlToTTconvertDir) = @_;

    $self->_loopDir($yamlToTTconvertDir, "yaml", "_convertYamlToTTExtention",
                    {_convertYamlToTTExtention => {yamlToTTconvertDir => $yamlToTTconvertDir}});
}

sub delete{
    my ($self, $instance) = @_;

    $self->{instance} = $instance;
    return if not defined $self->generateYaml();

    my $cluster   = $self->{config}->{cluster};
    my $namespace = $self->{config}->{namespace};
    print "\nDeleting Openshift components from instance: '$instance' in cluster: '$cluster' in namespace: '$namespace'\n";
    $self->_loopDir($self->{config}->{templates_yaml_dir}, "yaml", "_deleteOc");

    return;
}

sub generateConfigJsonTemplate{
    my ($self, $instances) = @_;

    print "Existing config file: $self->{ocConfigFile} will be overwriten do you want to continue?
Press enter to contiue or ctrl+c to abort";
    my $continue = <>;

    # preserve order in hash
    my $componentFromTemplatesTTDir = $self->_getComponentFromTemplatesTTDir();
    $componentFromTemplatesTTDir =~ s/\-/_/g;
    my @componentsArr = split(';', $componentFromTemplatesTTDir);
    tie my %configHash, 'Tie::IxHash';
    tie my %instanceSpecificData, 'Tie::IxHash';
    $configHash{instance_specific_data} = \%instanceSpecificData;
    foreach my $component (@componentsArr) {
        tie my %componentHash, 'Tie::IxHash';
        $instanceSpecificData{$component} = \%componentHash;
        my @instancesArr = split(';', $instances);
        foreach my $instance (@instancesArr) {
            $componentHash{$instance} = {};
        }
    }
    $configHash{instance_specific_name} = {};
    $configHash{git_repo} = {};
    tie my %projectHash, 'Tie::IxHash';
    $projectHash{name} = "";
    $projectHash{host} = "";
    $projectHash{cluster_ip_range} = "";
    $configHash{project} = \%projectHash;

    write_file($self->{ocConfigFile}, $self->{json}->pretty->encode(\%configHash));

    return;
}

sub generateYaml{
    my ($self) = @_;

    print "Instance is missing.\n" and return if not defined $self->{instance};

    $self->{config} = $self->_generateConfig();
    $self->_removeInitFromComponentDirs() if $self->{omit} =~ /init/;
    $self->_loopDir($self->{config}->{templates_tt_dir}, "*", "_createTemplatesTTDirHash");
    $self->_clearDir($self->{config}->{templates_yaml_dir});
    $self->_createYamlFiles();

    return 1;
}



sub install{
    my ($self, $instance) = @_;

    $self->{instance} = $instance;
    return if not defined $self->generateYaml();

    my $cluster   = $self->{config}->{cluster};
    my $namespace = $self->{config}->{namespace};
    print "\nInstalling Openshift components for instance: '$instance' in cluster: '$cluster' in namespace: '$namespace'\n";
    # sent custom params
    # $self->_loopDir($self->{config}->{templates_tt_dir}, "tt", "_callOc", {_callOc => {{param1 : "value1"}, {param2 : "value2"} }});
    $self->_loopDir($self->{config}->{templates_yaml_dir}, "yaml", "_callOc") if $self->{omit} !~ /oc/;

    print qq^\n\nTo get build and deployment status run: $self->{cliCommand} get pods | grep Running\n\n^;

    return;
}

sub setParams{
    my ($self, $params) = @_;

    if (@_ == 2) {
        $self->{advanceFeatures}       = $params->{advanceFeatures}      if defined $params->{advanceFeatures};
        $self->{clusterBaseAddress}    = $params->{clusterBaseAddress}   if defined $params->{clusterBaseAddress};
        $self->{cluster}               = $params->{cluster}              if defined $params->{cluster};
        $self->{ocConfigFile}          = $params->{ocConfigFile}         if defined $params->{ocConfigFile};
        $self->{host}                  = $params->{host}                 if defined $params->{host};
        $self->{ocResourceKinds}       = $params->{ocResourceKinds}      if defined $params->{ocResourceKinds};
        $self->{componentDirs}         = $params->{componentDirs}        if defined $params->{componentDirs};
        $self->{namespace}             = $params->{namespace}            if defined $params->{namespace};
        $self->{projectName}           = $params->{projectName}          if defined $params->{projectName};
        $self->{omit}                  = $params->{omit}                 if defined $params->{omit};
        $self->{urlPrefix}             = $params->{urlPrefix}            if defined $params->{urlPrefix};
        $self->{clusterIpRange}        = $params->{clusterIpRange}       if defined $params->{clusterIpRange};
        $self->{secretsDir}            = $params->{secretsDir}           if defined $params->{secretsDir};
        $self->{sortType}              = $params->{sortType}             if defined $params->{sortType};
        $self->{templatesTTDir}        = $params->{templatesTTDir}       if defined $params->{templatesTTDir};
        $self->{yamlToTTconvertDir}    = $params->{yamlToTTconvertDir}   if defined $params->{yamlToTTconvertDir};
        $self->{specificYamlFile}      = $params->{specificYamlFile}     if defined $params->{specificYamlFile};
        $self->{templatesYamlDir}      = $params->{templatesYamlDir}     if defined $params->{templatesYamlDir};
        $self->{validationReportFile}  = $params->{validationReportFile} if defined $params->{validationReportFile};
        $self->{projectDir}            = $params->{projectDir}            if defined $params->{projectDir};
        $self->{addFlagValuesToConfig} = $params->{addFlagValuesToConfig} if defined $params->{addFlagValuesToConfig};
        $self->{componentIsAllowed}    = $params->{componentIsAllowed}    if defined $params->{componentIsAllowed};
        $self->{generateUrl}           = $params->{generateUrl}           if defined $params->{generateUrl};
        $self->{removeClutter}         = $params->{removeClutter}         if defined $params->{removeClutter};
        $self->{removeClutterBackup}   = $params->{removeClutterBackup}   if defined $params->{removeClutterBackup};
    }
    return;
}

sub upgrade{
    my ($self, $instance) = @_;

    $self->validate($instance);

    my $validationReport      = read_file($self->{validationReportFile});
    my @validationReportLines = split /\n/, $validationReport;
    foreach my $line (@validationReportLines){
        my @items = split /;/, $line;
        if($items[-1] eq "MODIFIED"){
            my $pathAndFile = $items[0];
            my $ocKind      = $items[1];
            my $ocName      = $items[2];
            if($ocKind eq "PersistentVolumeClaim"){
                print "You are trying to update PersistentVolumeClaim.
Please make sure that all PODs that use this Persisten Volume are turned down before update.
If update operation start hanging at this step press ctrl+c to abort. \n\n";
            }
            print "Upgrading ocKind:$ocKind, ocName: $ocName from $pathAndFile\n";
            qx/$self->{cliCommand} delete $ocKind $ocName/;
            qx/$self->{cliCommand} create -f $self->{config}->{templates_yaml_dir}\/$pathAndFile/;
        }
    }
}

sub validate{
    my ($self, $instance) = @_;

    qx/> $self->{validationReportFile}/; # clear file
    $self->{instance} = $instance;
    return if not defined $self->generateYaml();

    my $cluster   = $self->{config}->{cluster};
    my $namespace = $self->{config}->{namespace};
    print "\nValidating Openshift components for instance: '$instance' in cluster: '$cluster' in namespace: '$namespace'\n";
    $self->_loopDir($self->{config}->{templates_yaml_dir}, "yaml", "_validateInstance");
}

sub _addSecretsToConfigHash{
    my ($self, $config, $dirFileName) = @_;

    my @dirFileNameArr = split('/', $dirFileName); # test, prod etc.

    my $secretText = read_file($dirFileName);
    $secretText =~ s/\n//g;
    $secretText =~ s/\r//g;
    $config->{secrets}->{$dirFileNameArr[-1]} = $secretText;

    my $secretTextBase64 = encode_base64($secretText);
    $secretTextBase64 =~ s/\n//g;
    $secretTextBase64 =~ s/\r//g;
    $config->{secrets}->{base64}->{$dirFileNameArr[-1]} = $secretTextBase64;

    return;
}

sub _backupInstance{
    my ($self, $params) = @_;

    my $dir          = $params->{dir};
    my $templateName = $params->{templateName};

    my $instance = $self->{config}->{instance};
    $self->_createDir("backups\/$instance\/$dir");
    my $pathToYamlFile = "$self->{config}->{templates_yaml_dir}/$dir/$templateName".".yaml";
    my $templateData = LoadFile($pathToYamlFile);

    my $yamlText;
    if((defined $self->{advanceFeatures}) &&
       ($self->{advanceFeatures} =~ /removeClutter/) &&
       (defined $self->{removeClutterBackup})){
        print "$self->{cliCommand} get $templateData->{kind} $templateData->{metadata}->{name} -o json\n";
        my $ocJson = qx/$self->{cliCommand} get $templateData->{kind} $templateData->{metadata}->{name} -o json/;
        my $ocHash  = $self->{json}->utf8->decode($ocJson);
        my $subParams = {"ocKind" => $templateData->{kind}, "ocName" => $templateData->{metadata}->{name}};
        $ocHash = $self->{removeClutterBackup}->($ocHash, $subParams);
        my $yamlSaveObj = YAML::Safe->new->boolean("JSON::PP");
        $yamlText = $yamlSaveObj->Dump($ocHash);
        $yamlText =~ s/---\n//;
    }else{
         print "$self->{cliCommand} get $templateData->{kind} $templateData->{metadata}->{name} -o yaml\n";
         $yamlText = qx/$self->{cliCommand} get $templateData->{kind} $templateData->{metadata}->{name} -o yaml/;
    }

    write_file("$self->{projectDir}backups\/$instance\/$dir/$templateName".".yaml", $yamlText);
}

sub _callOc{
    my ($self, $params) = @_;

    my @funcName = split /::/, (caller(0))[3];
    my $dir          = $params->{dir};
    my $templateName = $params->{templateName};
    my $customParams = $params->{params}->{$funcName[-1]};

    return if (defined $self->{componentIsAllowed}) &&
              (not $self->{componentIsAllowed}->($templateName, $dir, $self->{cluster}, $self->{instance}));

    my $templateNameYaml = $templateName.".yaml";
    my $pathAndFile = $self->{config}->{templates_yaml_dir}."\/$dir\/$templateNameYaml";
    my $yamlData = LoadFile($pathAndFile);

    if($yamlData->{kind} eq "CronJob"){
        print "$self->{cliCommand} apply -f $pathAndFile\n";
        qx/$self->{cliCommand} apply -f $pathAndFile/;
    }else{
        print "$self->{cliCommand} create -f $pathAndFile\n";
        qx/$self->{cliCommand} create -f $pathAndFile/;
    }
}

sub _clearDir{
    my ($self, $dir) = @_;

    rmtree $dir;
    make_path $dir;
}

sub _convertYamlToTTExtention{
    my ($self, $params) = @_;

    my @funcName           = split /::/, (caller(0))[3];
    my $dir                = $params->{dir};
    my $templateName       = $params->{templateName};
    my $customParams       = $params->{params}->{$funcName[-1]};
    my $yamlToTTconvertDir = $customParams->{yamlToTTconvertDir};

    my $path = "$yamlToTTconvertDir/$dir";
    qx/mv $path\/$templateName\.yaml $path\/$templateName\.tt 2>&1/;
}

sub _createTemplatesTTDirHash{
    my ($self, $params) = @_;

    my $dir          = $params->{dir};
    my $templateName = $params->{templateName};

    # $self->{templatesTTHash}->{"40-api"}->{"40-build-config-api"} = "40-api/clusterPublic/40-build-config-api";
    if(not -d "$self->{templatesTTDir}/$dir/$templateName"){
        $self->{templatesTTHash}->{$dir}->{$templateName} = "$dir/$templateName";
    }elsif($templateName eq $self->{cluster}){
        for my $dirFileName (File::Find::Rule->file()->name("*")->in("$self->{templatesTTDir}/$dir/$self->{cluster}")) {
            my @dirFileNameArr = split('/', $dirFileName);
            my $templName = substr($dirFileNameArr[-1], 0, -3);
            $self->{templatesTTHash}->{$dir}->{$templName} = "$dir/$self->{cluster}/$templName";
        }
    }

    return;
}

sub _createDir{
    my ($self, $relativeDirPath) = @_;
    qx/mkdir $self->{projectDir}$relativeDirPath 2>&1/;
    return;
}

sub _createYamlFiles{
    my ($self) = @_;

    # $self->{templatesTTHash}->{"40-api"}->{"40-build-config-api"} = "40-api/clusterPublic/40-build-config-api.tt";
    my $dirs = $self->{templatesTTHash};
    if((defined $self->{sortType}) && ($self->{sortType}) eq "alphabetic"){
        # alphabetic
        foreach my $dir (sort {lc($a) cmp lc($b)} keys %{$dirs}){
            my $files = $dirs->{$dir};
            foreach my $templateName (sort {lc($a) cmp lc($b)} keys %{$files}){
                $self->_generateYaml({dir => $dir, templateName => $templateName});
            }
        }
    }else{
        # numeric
        no warnings 'numeric';
        foreach my $dir (sort {lc($a) <=> lc($b)} keys %{$dirs}){
            my $files = $dirs->{$dir};
            foreach my $templateName (sort {lc($a) <=> lc($b)} keys %{$files}){
                $self->_generateYaml({dir => $dir, templateName => $templateName});
            }
        }
    }

    return;
}

sub _deleteOc{
    my ($self, $params) = @_;

    my $dir          = $params->{dir};
    my $templateName = $params->{templateName};

    my $data = LoadFile("$self->{config}->{templates_yaml_dir}/$dir/$templateName".".yaml");
    print "$self->{cliCommand} delete $data->{kind} $data->{metadata}->{name}\n";
    qx/$self->{cliCommand} delete $data->{kind} $data->{metadata}->{name}/;
}

sub _generateConfig{
    my ($self) = @_;

    my $ocConfigJson = read_file($self->{ocConfigFile});
    my $config->{oc_config} = $self->{json}->utf8->decode($ocConfigJson);

    $config = $self->{addFlagValuesToConfig}->($config) if defined $self->{addFlagValuesToConfig};

    # set/generate instance specific names
    foreach my $entry (keys %{$config->{oc_config}->{instance_specific_name}}){
        $config->{oc_config}->{instance_specific_name}->{$entry} .= "-$self->{instance}";
    }

    $config->{allowed_clusters}  = $config->{oc_config}->{project}->{allowed_clusters};
    if(not defined $config->{allowed_clusters}){
        print "INFO: oc_config->project->allowed_clusters json node is empty. Marking 'allowed_clusters' as '$self->{cluster}'\n";
        $config->{allowed_clusters} = $self->{cluster};
    }else{
        print "Warning: Unknown cluster $self->{cluster}\n" if $config->{allowed_clusters} !~ $self->{cluster};
    }

    $config->{cluster_ip_range} = $config->{oc_config}->{project}->{cluster_ip_range};
    $config->{cluster_ip_range} = $self->{clusterIpRange}       if defined $self->{clusterIpRange};
    $config->{project_name}     = $config->{oc_config}->{project}->{name};
    $config->{project_name}     = $self->{projectName}          if defined $self->{projectName};
    $config->{host}             = $config->{oc_config}->{project}->{host};
    $config->{host}             = $self->{host}                 if defined $self->{host};
    $config->{namespace}        = $config->{oc_config}->{project}->{namespace};
    $config->{namespace}        = $self->_getCurrentProject()   if not defined $config->{namespace};
    $config->{namespace}        = $self->{namespace}            if defined $self->{namespace};# from -n flag
    # default component dirs are set here, dirs in 'templates_tt' not set as default will be omitted
    $config->{component_dirs}   = $config->{oc_config}->{project}->{component_dirs};
    $config->{component_dirs}   = $self->{componentDirs}        if defined $self->{componentDirs};
    $config->{component_dirs}   = $self->_getComponentFromTemplatesTTDir() if not defined $config->{component_dirs};
    # component dirs can contains numbers e.g.: '50-solr' so regexp match is used =>
    # separate 'init' components in order to avoid false matches (e.g.: 20-init-api vs 50-api when 'api' searched)
    my @componentDirs                  = split(';', $config->{component_dirs});
    my $standardComponentDirs = "";
    my $initComponentDirs = "";
    foreach my $componentDir (@componentDirs){
        if($componentDir =~ /init/){
            $initComponentDirs     .= $componentDir.";";
        }else{
            $standardComponentDirs .= $componentDir.";";
        }
    }
    chop($initComponentDirs);
    chop($standardComponentDirs);
    $config->{init_component_dirs}        = $initComponentDirs;
    $config->{standard_component_dirs}    = $standardComponentDirs;
    $config->{oc_resource_kinds}          = $config->{oc_config}->{project}->{oc_resource_kinds};
    $config->{oc_resource_kinds}          = $self->{ocResourceKinds}  if defined $self->{ocResourceKinds};
    $config->{oc_resource_kinds}          = $self->_getDefaultKinds() if not defined $config->{oc_resource_kinds};
    $config->{templates_yaml_dir}         = $self->{templatesYamlDir};
    $config->{templates_tt_dir}           = $self->{templatesTTDir};
    $config->{cluster_camelcase}          = $self->{cluster};
    $config->{cluster}                    = lc $self->{cluster};
    $config->{instance}                   = lc $self->{instance};
    $config->{instance_capitalized_first} = ucfirst $config->{instance};
    $config->{url_prefix}                 = $self->{urlPrefix} if defined $self->{urlPrefix};
    $config->{cluster_base_address}       = $self->{clusterBaseAddress} if defined $self->{clusterBaseAddress};

    my $componentConfigNodes  = $self->_getComponentConfigNodes($config);
    foreach my $componentConfNode (@$componentConfigNodes){
        # set/generate default urls
        if((defined $config->{oc_config}->{instance_specific_data}->{$componentConfNode}) &&
           (ref($config->{oc_config}->{instance_specific_data}->{$componentConfNode}) eq 'HASH')){
            foreach my $instanceKey (keys %{$config->{oc_config}->{instance_specific_data}->{$componentConfNode}}){
                if(not defined $config->{oc_config}->{instance_specific_data}->{$componentConfNode}->{$instanceKey}->{url}){
                    my $componentNameKebab = $componentConfNode;
                    $componentNameKebab    =~ s/_/\-/g;
                    my $lcInstanceKey   = lc $instanceKey;
                    my $url = "";
                    if(defined $self->{generateUrl}){
                        $url = $self->{generateUrl}->($config->{url_prefix},
                                                      $config->{project_name},
                                                      $componentNameKebab,
                                                      $lcInstanceKey,
                                                      $config->{cluster_base_address},
                                                      $config->{host});
                    }
                    $config->{oc_config}->{instance_specific_data}->{$componentConfNode}->{$instanceKey}->{url} = $url;
                }
            }
        }
        # select instance specific data
        if(defined $config->{oc_config}->{instance_specific_data}->{$componentConfNode}->{$self->{instance}}){
            $config->{oc_config}->{instance_specific_data}->{$componentConfNode} =
                $config->{oc_config}->{instance_specific_data}->{$componentConfNode}->{$self->{instance}};
        }
    }
    # in worse case 36 available IP addresses(see _generateYaml), make number smaller if more needed(max is 256)
    $config->{ip_last_number} = int(rand(220));

    print "'Info: component_dirs' parameter is missing\n"   if not defined $config->{component_dirs};
    print "'Info: cluster_ip_range' parameter is missing\n" if not defined $config->{cluster_ip_range};
    print "'Info: host' parameter is missing\n"             if not defined $config->{host};

    $self->_getSecrets($config);

    return $config;
}

sub _generateYaml{
    my ($self, $params) = @_;

    my $dir          = $params->{dir};
    my $templateName = $params->{templateName};

    return if $dir =~ /init/ && $self->{omit} =~ /init/;
    return if (defined $self->{specificYamlFile}) && ($templateName !~ $self->{specificYamlFile});
    return if (defined $self->{componentIsAllowed}) &&
              (not $self->{componentIsAllowed}->($templateName, $dir, $self->{cluster}, $self->{instance}));

    my $yamlText;
    my $templatesYamlFilePath = "$self->{config}->{templates_yaml_dir}/$dir";
    make_path $templatesYamlFilePath or die("Failed to create path: $templatesYamlFilePath") if !-d $templatesYamlFilePath;

    # $self->{templatesTTHash}->{"40-api"}->{"40-build-config-api"} = "40-api/clusterPublic/40-build-config-api";
    my $templateTTFilePath = "$self->{templatesTTDir}/$self->{templatesTTHash}->{$dir}->{$templateName}";
    $templateTTFilePath = $templateTTFilePath.".tt";

    eval { $self->{tt}->process($templateTTFilePath, $self->{config}, \$yamlText); };
    if($@){
        print "Error occured during generating yaml in: $dir  $templateName\n", Dumper($@), "\n";
        return;
    }

    my $yamlHash;
    eval { $yamlHash = Load($yamlText);};
    if($@){
        print "Error occured during conversion to yaml in: $dir  $templateName\n", Dumper($@), "\n";
        return;
    }

    return if (defined $self->{ocResourceKinds}) && ($self->{ocResourceKinds} !~ $yamlHash->{kind});

    write_file("$templatesYamlFilePath/$templateName\.yaml", $yamlText);
    $self->{config}->{ip_last_number}++ if $yamlHash->{kind} eq "Service";
}

sub _getComponentConfigNodes{
    my ($self, $config) = @_;

    my @componentConfigNodes;
    my $componentConfigNodesString;
    if((defined $config->{oc_config}) && (defined $config->{oc_config}->{instance_specific_data})){
        foreach my $componentConfigNode (keys %{$config->{oc_config}->{instance_specific_data}}){
            push @componentConfigNodes, $componentConfigNode;
        }
    }

    return \@componentConfigNodes;
}

sub _getComponentFromTemplatesTTDir{
    my ($self) = @_;

    my $componentDirs = "";
    foreach my $dirPath (glob "$self->{templatesTTDir}/*") {
        next if not -d $dirPath;
        my @dirPathArr = split('/', $dirPath);
        my $componentDir = $dirPathArr[-1];
        $componentDir  =~ s/^\d+-//;
        $componentDirs .= $componentDir.";";
    }
    chop($componentDirs) if $componentDirs ne "";

    return $componentDirs;
}

sub _getCurrentProject{
    my ($self) = @_;

    my $projectCmdLine    = qx/$self->{cliCommand} config current-context/;
    my @projectCmdLineArr = split('/', $projectCmdLine);
    my $project = $projectCmdLineArr[0];
    $project = "unknown" if not defined $project;

    return $project;
}

sub _getDefaultKinds{
    return "PersistentVolumeClaim;StorageClass;VolumeSnapshot;ImageStream;BuildConfig;Deployment;DeploymentConfig;StatefulSet;Secret;ConfigMap;CronJob;Job;DaemonSet;ReplicaSet;ReplicationController;HorizontalPodAutoscaler;PodDisruptionBudget;Service;Route;Ingress;NetworkPolicy;ServiceAccount;ClusterRole;RoleBinding;ResourceQuota;LimitRange";
}

sub _getSecrets{
    my ($self, $config) = @_;

    my $secretJsonFileName = $self->{secretsJson};
    # secrets files for all instances and all clusters e.g.: secrets/my-secret.txt
    for my $dirFileName (File::Find::Rule->file()->name("*")->in($self->{secretsDir})) {
        my @dirFileNameArr = split('/', $dirFileName);
        next if $dirFileNameArr[-1] eq $secretJsonFileName;
        $self->_addSecretsToConfigHash($config, $dirFileName) if scalar @dirFileNameArr == 2;
    }

    # instance specific secrets files and for all clusters e.g.: secrets/instance/test/my-secret.txt
    for my $dirFileName (File::Find::Rule->file()->name("*")->in("$self->{secretsDir}/instance/$self->{instance}")) {
        my @dirFileNameArr = split('/', $dirFileName);
        next if $dirFileNameArr[-1] eq $secretJsonFileName;
        $self->_addSecretsToConfigHash($config, $dirFileName) if scalar @dirFileNameArr == 4;
    }

    my $clusterSpecificSecretsDirExist = 0;
    foreach my $dirPath (glob "$self->{secretsDir}/*") {
        next if not -d $dirPath;
        my @dirPathArr = split('/', $dirPath);
        my $dirName = $dirPathArr[1];
        next if $dirName eq "instance";
        $clusterSpecificSecretsDirExist = 1 if $dirName eq $self->{cluster};
    }

    # secrets files for all instances and for specific cluster e.g.: secrets/clusterIntern/my_secret.txt
    if($clusterSpecificSecretsDirExist){
        for my $dirFileName (File::Find::Rule->file()->name("*")->in("$self->{secretsDir}/$self->{cluster}")) {
            my @dirFileNameArr = split('/', $dirFileName);
            next if $dirFileNameArr[-1] eq $secretJsonFileName;
            $self->_addSecretsToConfigHash($config, $dirFileName) if scalar @dirFileNameArr == 3;
        }
        # secret files for specific instance and specific cluster e.g.: secrets/clusterIntern/instance/prod/my_secret.txt
        for my $dirFileName (File::Find::Rule->file()->name("*")->in("$self->{secretsDir}/$self->{cluster}/instance/$self->{instance}")) {
            my @dirFileNameArr = split('/', $dirFileName);
            next if $dirFileNameArr[-1] eq $secretJsonFileName;
            $self->_addSecretsToConfigHash($config, $dirFileName) if scalar @dirFileNameArr == 5;
        }
    }

    # secrets json for all instances and all clusters
    my $secretJson = read_file("$self->{secretsDir}/$secretJsonFileName");
    $config->{secrets_json} = $self->{json}->utf8->decode($secretJson);
    if($clusterSpecificSecretsDirExist){
        # secrets json for all instances and specific cluster
        my $path = "$self->{secretsDir}/$self->{cluster}/$secretJsonFileName";
        my $secretJsonClusterSpecific = read_file($path);
        my $secretJsonClusterSpecificHash = $self->{json}->utf8->decode($secretJsonClusterSpecific);
        $self->_mergeSecretsJson($config->{secrets_json}, $secretJsonClusterSpecificHash);

        # secrets json for specific instance and specific cluster
        $path = "$self->{secretsDir}/$self->{cluster}/instance/$self->{instance}/$secretJsonFileName";
        my $secretJsonClusterSpecificInstanceSpecific = read_file($path);
        my $secretJsonClusterSpecificInstanceSpecificHash = $self->{json}->utf8->decode($secretJsonClusterSpecificInstanceSpecific);
        $self->_mergeSecretsJson($config->{secrets_json}, $secretJsonClusterSpecificInstanceSpecificHash);
    }else{
        # secrets json for specific instance and all clusters
        my $path = "$self->{secretsDir}/instance/$self->{instance}/$secretJsonFileName";
        my $secretJsonInstanceSpecific = read_file($path);
        my $secretJsonInstanceSpecificHash = $self->{json}->utf8->decode($secretJsonInstanceSpecific);
        $self->_mergeSecretsJson($config->{secrets_json}, $secretJsonInstanceSpecificHash);
    }

    return;
}

sub _loopDir {
    my ($self, $dirToLoop, $extention, $injectedSubName, $params) = @_;

    my $templates = {};
    for my $dirFileName (File::Find::Rule->file()->name("*.$extention")->in($dirToLoop)) {
        $dirFileName =~ s/$dirToLoop\///;
        my @dirFile  = split('\/', $dirFileName);
        my @dir      = split('\-', $dirFile[0]);
        my @file     = split('\-', $dirFile[1]);
        # e.g: $templates->{30-solr}->{dirNumber}               = 30 # in order so sort as integer
        #                           ->{20-build-config-solr.tt} = 20
        $templates->{$dirFile[0]}->{dirNumber}   = $dir[0];
        $templates->{$dirFile[0]}->{$dirFile[1]} = $file[0];
    }

    my @dirArray;
    if((defined $self->{sortType}) && ($self->{sortType}) eq "alphabetic"){
        foreach my $dir (sort { lc $templates->{$a}->{dirNumber} cmp lc $templates->{$b}->{dirNumber} } keys %{$templates}){
            push @dirArray, $dir;
        }
    }else{
        # numeric
        no warnings 'numeric';
        foreach my $dir (sort { $templates->{$a}->{dirNumber} <=> $templates->{$b}->{dirNumber} } keys %{$templates}){
            push @dirArray, $dir;
        }
    }
    @dirArray = reverse @dirArray if $injectedSubName eq "_deleteOc";

    foreach my $dir (@dirArray){
        print "\nInstalling components from: $dir:\n" if $injectedSubName eq "_callOc";

        my @fileArray;
        if((defined $self->{sortType}) && ($self->{sortType}) eq "alphabetic"){
            foreach my $file (sort { lc $templates->{$dir}->{$a} cmp  lc $templates->{$dir}->{$b} } keys %{$templates->{$dir}}){
                push @fileArray, $file;
            }
        }else{
            # numeric
            no warnings 'numeric';
            foreach my $file (sort { $templates->{$dir}->{$a} <=> $templates->{$dir}->{$b} } keys %{$templates->{$dir}}){
                push @fileArray, $file;
            }
        }
        @fileArray = reverse @fileArray if $injectedSubName eq "_deleteOc";
        foreach my $file (@fileArray){
            next if $file eq "dirNumber" || $self->_skipComponent($dir);
            my @fileArr = split('\.', $file);
            if((not defined $fileArr[1]) && ($self->{config}->{allowed_clusters} !~ /$file/)){
                print "Warning : Unknown cluster: $file\n";
            }
            my $injectedSub = \&$injectedSubName;
            $injectedSub->($self, {dir => $dir, templateName => $fileArr[0], params => $params});
        }
    }
}

sub _mergeSecretsJson{
    my ($self, $jsonHashOriginal, $jsonHashAddition) = @_;

    foreach my $key (keys %{$jsonHashAddition}){
        $jsonHashOriginal->{$key} = $jsonHashAddition->{$key}
    }

    return;
}

sub _removeInitFromComponentDirs{
    my ($self) = @_;

    my @componentsYamlDirArray       = split(';', $self->{config}->{component_dirs});
    @componentsYamlDirArray          = (grep {$_ !~ /init/} @componentsYamlDirArray);
    $self->{config}->{component_dirs} = join( ';', @componentsYamlDirArray);
}

sub _skipComponent{
    my ($self, $dir) = @_;

    # ignore skiping if called by this flag
    return 0 if defined $self->{yamlToTTconvertDir};

    my @installComponents = [];
    if($dir =~ /init/){
        if(defined $self->{config}->{init_component_dirs}){
            @installComponents = split(';', $self->{config}->{init_component_dirs});
        }
        foreach my $installComponent (@installComponents){
            return 0 if $dir =~ /$installComponent/;
        }
    }else{
        if(defined $self->{config}->{standard_component_dirs}){
            @installComponents = split(';', $self->{config}->{standard_component_dirs});
        }
        foreach my $installComponent (@installComponents){
            return 0 if $dir =~ /$installComponent/;
        }
    }

    return 1;
}

sub _validateInstance{
    my ($self, $params) = @_;

    my @funcName = split /::/, (caller(0))[3];
    my $dir          = $params->{dir};
    my $templateName = $params->{templateName};

    my $templateNameYaml = $templateName.".yaml";
    my $yamlData         = LoadFile("$self->{config}->{templates_yaml_dir}/$dir/$templateNameYaml");
    my $ocName           = $yamlData->{metadata}->{name};
    my $ocKind           = $yamlData->{kind};
    my $ocJson           = qx/$self->{cliCommand} get $ocKind $ocName -o json/;
    my $ocHash = {};
    eval {
        $ocHash  = $self->{json}->utf8->decode($ocJson);
        if(($ocKind eq "Secret") && (ref($ocHash->{data}) eq 'HASH')){
            foreach my $key (keys %{$ocHash->{data}}){
                my $secret = decode_base64($ocHash->{data}->{$key});
                $secret =~ s/\n//g;
                $secret =~ s/\r//g;
                $ocHash->{data}->{$key} = $secret;
            }
        }
    };
    print Dumper($@) if $@;

    my $templateYamlText = read_file("$self->{config}->{templates_yaml_dir}/$dir/$templateNameYaml");
    my $yamlObj = YAML::Safe->new->boolean("JSON::PP");
    my $templateHash = $yamlObj->Load($templateYamlText);
    my $subParams = {"dir" => $dir, "templateName" => $templateName, "ocKind" => $ocKind, "ocName" => $ocName};
    $ocHash       = $self->{removeClutter}->($ocHash, $subParams)       if defined $self->{removeClutter};
    $templateHash = $self->{removeClutter}->($templateHash, $subParams) if defined $self->{removeClutter};

    if($ocKind eq "Secret"){
        if((defined $templateHash->{data}) && (ref($templateHash->{data}) eq 'HASH')){
            foreach my $key (keys %{$templateHash->{data}}){
                my $dataBase64Encoded = $templateHash->{data}->{$key};
                my $dataBase64Decoded = decode_base64($dataBase64Encoded);
                $dataBase64Decoded =~ s/\n//g;
                $dataBase64Decoded =~ s/\r//g;
                $templateHash->{data}->{$key} = $dataBase64Decoded;
            }
        }
    }

    $ocJson          =  $self->{json}->utf8->pretty->canonical->encode($ocHash);
    my $templateJson =  $self->{json}->utf8->pretty->canonical->encode($templateHash);
    my @ocJsonArr       = split /\n/, $ocJson;
    my @templateJsonArr = split /\n/, $templateJson;
    my $diff = diff \@ocJsonArr, \@templateJsonArr, { STYLE => "Table", CONTEXT => 0 };
    if(($ocKind eq "Secret") && ($diff ne "")){
        $diff = "+---+-----------------------------------------------------+---+---------------------------------+
*   |           different secret, not displayed           *   | different secret, not displayed |
+---+-----------------------------------------------------+---+---------------------------------+
";
    }
    $diff =~ s/\\ No newline at end of file\s//g;

    my $diffStatus;
    if((defined $diff) && ($diff ne "")){
        $diffStatus = "MODIFIED";
    }else{
         $diffStatus = "OK";
    }
    my $line = "$dir/$templateNameYaml;$ocKind;$ocName;$diffStatus\n";
    print $line;
    print $diff if $diff ne "";
    write_file($self->{validationReportFile}, {append => 1}, $line);
}

1;

__END__