bug795935.py

#!/usr/bin/env python
# encoding: utf-8
#   Copyright 2011 Red Hat, Inc.
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#        Regression test for Image Factory #Bug 795935 - Remove plain text passwords from /etc/imagefactory/provider.json files
#        Created by koca (mkoci@redhat.com)
#        Date: 24/02/2012
#        Issue: https://bugzilla.redhat.com/show_bug.cgi?id=795935  
# return values:
# 0 - OK: everything OK
# 1 - Fail: setupTest wasn't OK
# 2 - Fail: bodyTest wasn't OK
# 3 - Fail: cleanTest wasn't OK
# 4 - Fail: any other error (reserved value)

#necessary libraries
import os
import sys
from syck import *
import shutil
configuration = load(file("configuration.yaml", 'r').read())
#constants 
SUCCESS=0
FAILED=1
RET_SETUPTEST=1
RET_BODYTEST=2
RET_CLEANTEST=3
RET_UNEXPECTED_ERROR=4
ROOTID=0
#setup
LogFileIF=configuration["LogFileIF"]
LogFileIWH=configuration["LogFileIWH"]
rhvemJSONFile=configuration["rhvemJSONFile"]
vsphereJSONFile=configuration["vsphereJSONFile"]
RHEVMbugFile=configuration["RHEVMbugFile"]
RHEVMconfigureFile=configuration["RHEVMconfigureFile"]
RHEVMBackupFile=configuration["RHEVMBackupFile"]
VSPHEREbugFile=configuration["VSPHEREbugFile"]
VSPHEREconfigureFile=configuration["VSPHEREconfigureFile"]
VSPHEREBackupFile=configuration["VSPHEREBackupFile"]


def setupTest():
    print "=============================================="
    print "Setup of the regression test based on bug795935 - Remove plain text passwords from /etc/imagefactory/provider.json files"
    print "See the bug for further information - https://bugzilla.redhat.com/show_bug.cgi?id=795935"
    print "Checking if you have enough permission..."
    if os.geteuid() != ROOTID:
        print "You must have root permissions to run this script, I'm sorry buddy"
        return False #exit the test
    #run the cleanup configuration
    print "Cleanup configuration...." 
    if os.system("aeolus-cleanup") != SUCCESS:
        print "Some error raised in aeolus-cleanup !"

    #first backup old rhvm file
    print "Backup old rhevm configuration file"
    if os.path.isfile(RHEVMconfigureFile):
        shutil.copyfile(RHEVMconfigureFile, RHEVMBackupFile)
    #then copy the conf. file
    print "Copy rhevm configuration file to /etc/aeolus-configure/nodes/rhevm_configure"
    if os.path.isfile(RHEVMbugFile):
        shutil.copyfile(RHEVMbugFile, RHEVMconfigureFile)
    else:
        print RHEVMbugFile + " didn't find!"
        return False
    
    #first backup old vsphere file
    print "Backup old vsphere configuration file"
    if os.path.isfile(VSPHEREconfigureFile):
        shutil.copyfile(VSPHEREconfigureFile, VSPHEREBackupFile)
    #then copy the conf. file
    print "Copy vsphere configuration file to /etc/aeolus-configure/nodes/vsphere_configure"
    if os.path.isfile(VSPHEREbugFile):
        shutil.copyfile(VSPHEREbugFile, VSPHEREconfigureFile)
    else:
        print VSPHEREbugFile + " didn't find!"
        return False
    
    if os.path.isfile(rhvemJSONFile):    
        os.remove(rhvemJSONFile)

    if os.path.isfile(vsphereJSONFile):    
        os.remove(vsphereJSONFile)
                            
    #now run aeolus-configure -p rhevm and uses the values from /etc/aeolus-configure/nodes/rhevm_configure
    print "running aeolus-configure -p rhevm,vsphere"
    if os.system("aeolus-configure -p rhevm,vsphere") != SUCCESS:
        print "Some error raised in aeolus-configure with parameter -p rhevm,vsphere !"
        return False
           
    print "Clearing log file for Image Factory"
    os.system("> " + LogFileIF)
    print "Clearing log file for Image Warehouse"
    os.system("> " + LogFileIWH)
    return True
   
#body
def bodyTest():
#check if aeolus-cleanup removes directory. /var/tmp and /var/lib/iwhd/images
    print "=============================================="
    print "test being started"
    print "Checking if there is password/username in json's files..."
    if os.system("grep -i \"password\|username\" " +  rhvemJSONFile) == SUCCESS:
        print "Ergh, there is password and/or username in rhevm json file :("
        print "See the output from json file " + rhvemJSONFile + ":"
        print "======================================================"
        outputtmp = os.popen("cat " + rhvemJSONFile).read()
        print outputtmp
        return False
    else:
        if os.system("grep -i \"password\|username\" " +  vsphereJSONFile) == SUCCESS:
            print "Ergh, there is password and/or username in vsphere json file :("
            print "See the output from json file " + vsphereJSONFile + ":"
            print "======================================================"
            outputtmp = os.popen("cat " + vsphereJSONFile).read()
            print outputtmp            
            return False
    outputtmp = os.popen("cat " + vsphereJSONFile).read()
    print "Vsphere json file " + vsphereJSONFile + ":"
    print outputtmp
    outputtmp = os.popen("cat " + rhvemJSONFile).read()
    print "rhvem json file " + rhvemJSONFile + ":"
    print outputtmp     
    return True
 
#cleanup after test
def cleanTest():
    print "=============================================="
    print "Cleaning the mess after test"
    if os.path.isfile(RHEVMBackupFile):
        #copy file back rhevm
        shutil.copyfile(RHEVMBackupFile, RHEVMconfigureFile) 
        
    if os.path.isfile(VSPHEREBackupFile):
        #copy file back vsphere
        shutil.copyfile(VSPHEREBackupFile, VSPHEREconfigureFile) 
    return True
 
#execute the tests and return value (can be saved as a draft for future tests)
if setupTest(): 
    if bodyTest():
        if cleanTest():
            print "=============================================="
            print "Test PASSED entirely !"
            sys.exit(SUCCESS)
        else:
            print "=============================================="
            print "Although Test was successful, cleaning after test wasn't successful !"
            sys.exit(RET_CLEANTEST)
    else:
        print "=============================================="
        print "Test Failed !"
        cleanTest()
        sys.exit(RET_BODYTEST)
else:
    print "=============================================="
    print "Test setup wasn't successful ! Test didn't even proceed !"
    cleanTest()
    sys.exit(RET_SETUPTEST)