Software Development and Deployment

Transcription

1 Software Development and Deployment In an Oracle Environment Discussion Overview Introduction ti Software Configuration Management Development and Deployment roles Development evolution Ant control Software deployment process Configuration Build details

2 Introduction About me My role as a Systems Consultant Requirements Definition iti Systems Design and Specifications Manage overall application development project Client interactions Software development activities Requirements Clarification Change Control QA and Customer Acceptance Release coordination and control Ongoing g configuration management

3 Introduction Our space Our typical application environment Sun ONE Web Server on Sun Solaris server Oracle 10g on Sun Solaris server CVS or Subversion code repository Eclipse IDE PL/SQL Developer IDE Environment independence p Development / QA / Production

4 Introduction Our space another dimension Our typical application architecture Web-based b UI JSP/Java/JDBC/JDBC Middleware framework Spring or Struts[2] Oracle back end - PL/SQL packages containing procedures and functions Unix Shell utilities - Perl, ksh, embedded SQL Application glue Web Services XML

5 Software Configuration Management Areas of influence When we say SCM we mean Control over source modules Coordination of development activities QA checkpoint control Versioning Release control Production instance control

6 Software Development and Deployment Software Developer Write application code Unit test code modules Check-In tested code Release Coordinator Check-Out, Build, and Deploy Dev image QA image Tag configuration for release Production Release QA Verify functionality Open tickets to track defects Who does what Project Manager Manage Customer Acceptance process Obtain customer sign-off prior to Production deployment

7 Evolution of PL/SQL Development Process Unix shell editor Save in shell Run SQL/Plus and compile Save in source control (SCCS) Deploy manually PL/SQL Developer Copy / Paste tested t code to shell file for SCCS check-in Build in PL/SQL Developer connected to Prod environment Eclipse and Ant Import into Eclipse via local PL/SQL Developer file Versioning and Tagging Scripted deployment of tagged release

8 Ant! Consistent approach to building/deploying different languages Java PL/SQL Script (Perl, ksh) SQL tasks Ant build targets Checkout Build and Deploy Tag Release Deploy Release

9 Production release identifier Major Minor Patch Release Identifiers Versioning 1.01 Example: R_ QA level release Lower level to track sub-releases Example: R_ Release script prompts for best guess at version

10 Releasing SQL scripts One-time tasks Tied to Ticket Tracking identifier Option to handle Dev, QA, and Prod versions independently Executes appropriate script for target environment Script types SQL command (Insert, Update, etc) PL/SQL Procedure ant build script

11 Release Process Control Sample worksheet Build dir Env Activity Tag / Argument Completed Notes sql Dev ant checkout 12/21/2009 / 3:47 PM 2/5/ :36 AM Dev ant deploy 2/5/ :36 AM Dev ant tagrelease R_ /21/2009 3:49 PM R_ /5/ :36 AM R_ /7/2010 4:38 PM QA ant deployrelease R_ R_ R_ /21/2009 3:50 PM 2/5/ :36 AM 3/7/2010 8:08 PM QA ant release scripts , /21/2009 3:59 PM 2/5/ :38 AM Prod ant deployrelease R_ /7/2010 9:18 PM Prod ant release scripts , /7/2010 9:28 PM

12 Application Code Organization of Modules PL/SQL code stored under one project in application comprised of java, perl, and shell scripts. enotify build: master build file and release.properties enotify ui: java web application enotify orderstatuseventws: t t t java web service app enotify sendmailws: java web service app enotify common: common java code and third party libraries enotify sql: database code: PL/SQL packages and procedures, SQL scripts enotify data server tasks: misc perl and shell scripts enotify support: standalone java app SQL Project All release steps controlled through standard targets in master build.xml and release.properties: checkout: checkout project from HEAD or release tag build: build the component (per project build.xml) l) deploy: deploy the component (per project build.xml) tagrelease: tag the built component with release name, tracks release numbers deployrelease: checkout the tagged released component and deploy release scripts: execute any release scripts (e.g., pl/sql procedures, SQL scripts, and/or add l build scripts) for the release (driven by ticket number) Project build.xml scripts and build.properties files are unique for each type of project

13 Development Process Use PL/SQL Developer to edit and test PL/SQL code. Create and test SQL scripts Save packages and/or scripts into local copy of CVS repository Check in changes into repository Perform release on development server ant checkout Checks out latest code into build directory on Dev server ant tagrelease Prompts for release name defaulting to next QA release saved in properties. Tags files as QA release (e.g., R_ ) and production release candidate (e.g, R_ ). Updates properties storing latest release names and next release number. d l l ant deployrelease Prompts for release name defaulting to last QA release name, checks out files from release tag and deploys (compiles new PL/SQL packages and recompiles any invalidated packages).

14 QA Deployment Deploy QA tagged release on QA server ant deployrelease Prompts for release name defaulting to last QA release name, checks out files from release tag and deploys Only builds items that have changed ant release scripts scripts (optional) Prompts for ticket numbers and executes any procedures, scripts and/or build scripts found for the ticket

15 Production Release Deploy tagged release on Production server ant deployrelease prompts for release name defaulting to last production release name, checks out files from release tag and deploys Only builds items that have changed ant release scripts (optional) prompts for ticket numbers and executes any procedures, scripts and/or build scripts found for the ticket

16 Properties files release.properties (shared by all projects): release.prefix=r_ release.name.qa.last=r_ release.patch.number.next=14 release.minor.number.next=03 release.create.timestamp= \:33\:16 \ release.major.number.next=01 release.name.last=r_ release.qa.number.next=06 Release versioning parameters build.properties (unique for each project): cvs.project.list=enotify sql project.name=enotify Database dir.development=/uv1157/u311/home/enotify dir.production=/uv1233/u311/home/enotify dir.qa=/uv1510/u01/home/enotify jdbc.connection.development=host.apps.mc.xerox.com\:1571\:oscp jdbc.user.development=user jdbc.password.development=password jdbc.connection.qa=host.apps.mc.xerox.com\:1552\:oscq jdbc.user.qa=user jdbc.password.qa=password jdbc connection production=host apps mc xerox com\:1571\:oscp jdbc.connection.production=host.apps.mc.xerox.com\:1571\:oscp jdbc.user.production=user jdbc.password.production=password

17 <! Tag the current component for release > <target name="tagrelease" depends="checkproperties"> Master build.xml tagrelease Target <! define cvsroot > <input message="enter your cvs userid:" addproperty="cvs.userid"/> <property name="cvsroot" <! generate the default qa release tag > <property name="default.qa.release.name" value="${release.prefix}${release.major.number.next} ${release.minor.number.next} ${release.patch.number.next} ${release.qa.number.next}"/> <! prompt for qa release name > <input message="enter the qa release tag or press enter for default:" addproperty="qa.release.name" defaultvalue="${default.qa.release.name}"/> <! Validate release name and update build.properties file to store next release numbers > > <if> <equals arg1="${qa.release.name}" arg2="${default.qa.release.name}"/> <then> <! if qa release name equals default qa release name then just increment qa number > <echo>creating incremental release ${qa.release.name}.</echo> </then> <else> <! extract the numbers from the new qa release, save in properties > <propertyregex property="release.major.number.new" input="${qa.release.name}" regexp="${release.prefix}(\d\d) (\d\d) (\d\d) (\d\d)" select="\1" /> <fail unless="release.major.number.new" message="invalid release name format. Expect ${release.prefix}nn nn nn nn"/>. Check minor, patch and qa number in same way <echo>creating new major release ${qa.release.name}.</echo> <propertyfile file="release.properties"> <entry key="release.major.number.next" type="int" operation="=" value="${release.major.number.new}" pattern="00"/> <entry key="release.minor.number.next" type="int" operation="=" value="${release.minor.number.new}" pattern="00"/> <entry key="release.patch.number.next next" type="int" operation="=" = value="${release ${release.patch.number.new} new}" pattern="00"/> <entry key="release.qa.number.next" type="int" operation="=" value="${release.qa.number.new}" pattern="00"/> </propertyfile> </else> </if>

18 tagrelease Target (cont.) <! generate the production release tag based on the qa release tag > <propertyregex property="release.name" input="${qa.release.name}" regexp="${release.prefix}(\d\d) (\d\d) (\d\d) (\d\d)" select="${release.prefix}\1 \2 \3" /> <echo>the h production release name tag is: ${release.name}</echo> <! update release properties file to include this release name as last release and increment next qa number > <tstamp> <format property="timestamp" pattern="mm dd yyyy hh:mm:ss"/> </tstamp> <propertyfile file="release release.properties properties"> <entry key="release.qa.number.next" type="int" operation="+" default="00" pattern="00"/> <entry key="release.name.last" value="${release.name}"/> <entry key="release.name.qa.last" value="${qa.release.name}"/> <entry key="release.create.timestamp" value="${timestamp}"/> </propertyfile> <! commit the new release.properties > <copy file="release.properties" tofile="${cvs.build project}/release.properties" failonerror="false"/> <cvs cvsroot="${cvsroot}" command="commit m'${qa.release.name}' ${cvs.build project}/release.properties" failonerror="true"/> <! tag each project with release name and qa release name > <for list="${cvs.project.list}" param="cvs.project"> <sequential> <ant target="createrelease" dir="@{cvs.project}"/> <cvs cvsroot="${cvsroot}" command="tag F ${release.name}" package="@{cvs.project}" failonerror="true"/> <cvs cvsroot="${cvsroot}" command="tag F ${qa.release.name}" package="@{cvs.project}" failonerror="true"/> </sequential> </for> <echo>the component ${project.name} has been tagged for release: ${release.name}. qa release: ${qa.release.name}</echo> </target> Attach Tag to all files in this project

19 Master build.xml deployrelease Target <! Checkout the release files from cvs and deploy > <target name="deployrelease" depends="checkproperties"> <echo>deploy a release for component ${ant.project.name} on ${env.hostname} [${env.environment}]</echo> <condition property="defaultreleasevalue" value="${release.name.qa.last}"> <isset property="isdevelopment"/> </condition> <condition property="defaultreleasevalue" value="${release.name.qa.last}"> <isset property="isqa"/> </condition> <condition property="defaultreleasevalue" value="${release.name.last}"> <isset property="isproduction"/> </condition> <fail unless="defaultreleasevalue"/> <input message="enter release name :" addproperty="tag" defaultvalue="${defaultreleasevalue}"/> <! checkout from release tag > <ant target="checkout"/> <! deploy release > <for list="${cvs.project.list}" param="cvs.project"> <sequential> <ant target="deployrelease" dir="@{cvs.project}"/> </sequential> </for> </target> Get code for release Call individual build targets

20 deployrelease target <! Required target: deployrelease > <target name="deployrelease" > <! same as regular deploy > <antcall target="deploy"/> </target> Individual build.xml SQL project deploy target <target name="deploy"> <! Compile any package file from the cvs packages directory which is different than the package in the deployed packages directory. > <for param="package" package > <path> <fileset dir="${cvs.dir.packages}"> <different targetdir="${dir.deployed.packages}" ignorefiletimes="true"/> </fileset> </path> <sequential> <echo>deploy <antcall target="compilepackage"> <param name="package.file" </antcall> </sequential> </for> <! Recompile any invalidated packages caused by compilation > <antcall target="recompile invalid packages"/> <echo>check for compilation errors </echo> <antcall target="check for compilation errors"/> </target> Call for package compile Recompile any invalid packages Report compile errors

21 SQL project compilepackage Target <! Compile the package: ${package.file} > <target name="compilepackage"> l k " <fail unless="package.file"/> <basename file="${package.file}" property="package.filename"/> <basename file="${package.file}" suffix="pck" property="package.name"/> <echo>copy the package ${package.file} to deploy directory: ${dir.deployed.packages}</echo> <copy file="${package.file}" tofile="${dir.deployed.packages}/${package.filename}" preservelastmodified="true" overwrite="true"/> <echo>compile the package ${dir.deployed.packages}/${package.filename}</echo> <antcall target="execute plsql code"> <param name="file" value="${dir.deployed.packages}/${package.filename}"/> </antcall> Call package compilation </target>

22 SQL project execute plsql code code target <! Execute the pl/sql code in file: ${file} > <target name="execute plsql code" p q depends="jdbcsetup"> j p <fail unless="file"/> <fail unless="jdbc.user"/> <fail unless="jdbc.password"/> <fail unless="jdbc.url"/> <echo>execute the PL/SQL code from file ${file}</echo> <sql driver="oracle.jdbc.oracledriver" url="${jdbc.url}" userid="${jdbc.user}" password="${jdbc ${jdbc.password} password}" classpathref="sql.classpath" delimitertype="row" delimiter="/" keepformat="yes" escapeprocessing="false" onerror="abort"> <transaction src="${file}"/> </sql> JDBC call to Oracle for package compilation </target>

23 <target name="jdbcsetup"> SQL project jdbcsetup target <condition property="jdbc.user" value="${jdbc.user.development}"> <equals arg1="${isdevelopment}" arg2="true"/> </condition> <condition property="dir.deployed.packages" value="${dir.development}/packages"> <equals arg1="${isdevelopment}" arg2="true"/> </condition> <condition property="jdbc.user" value="${jdbc.user.qa}"> <equals arg1="${isqa}" arg2="true"/> </condition> <condition property="dir.deployed.packages" value="${dir.qa}/packages"> <equals arg1="${isqa}" arg2="true"/> </condition> <condition property="jdbc.user" value="${jdbc.user.production}"> <equals arg1="${isproduction}" arg2="true"/> </condition> <condition property="dir.deployed.packages" value="${dir.production}/packages"> <equals arg1="${isproduction}" arg2="true"/> </condition> <fail unless="jdbc.user"> Cannot determine the jdbc user property. </fail> <fail unless="dir.deployed.packages"> Cannot determine the dir.deployed.packages property. </fail> </target>

24 <target name="recompile invalid packages"> SQL project recompile invalid packages invalid packages target <echo>recompile invalidated packages using procedure in file: ${file.proc.recompile.invalid.packages}</echo> <antcall target="execute plsql code"> <param name="file" value="${file.proc.recompile.invalid.packages} </antcall> </target> file.proc.recompile.invalid.packages declare cursor mycursor is select object_type, object_name from SYS.USER_OBJECTS where status = 'INVALID' order by 1, 2; sqlstring varchar2(100); begin for r1 in mycursor loop if r1.object_type = 'PACKAGE BODY' then sqlstring := 'alter PACKAGE ' r1.object_name ' compile BODY'; elsif r1.object_type = 'TYPE BODY' then sqlstring := 'alter TYPE ' r1.object _ name ' compile BODY'; else sqlstring := 'alter ' r1.object_type ' ' r1.object_name ' compile'; end if; execute immediate sqlstring; end loop; end; Cursor of invalidated objects Compile packages and other objects

25 <target name="check for compilation errors" depends="jdbcsetup"> SQL project check for compilation errors compilation errors <echo>check for compilation errors in package : ${package}</echo> <sql driver="oracle.jdbc.oracledriver" url="${jdbc.url}" userid="${jdbc.user}" password="${jdbc.password}" classpathref="sql.classpath" delimitertype="row" delimiter="/" keepformat="yes" escapeprocessing="false" onerror="abort"> <transaction> <![CDATA[ BEGIN DECLARE NUM INTEGER; ERROR_TEXT USER_ERRORS.TEXT%TYPE; SQL to check for compile errors SELECT Count(*) INTO NUM FROM USER_ERRORS WHERE Type = 'PACKAGE' OR Type = 'PACKAGE BODY' AND NAME = '${package}'; If num > 0 Then SELECT TEXT INTO ERROR_TEXT FROM USER_ERRORS WHERE Type = 'PACKAGE' OR Type = 'PACKAGE BODY' AND NAME = '${package}' AND SEQUENCE = 1; RAISE_APPLICATION_ERROR( 20000, ERROR_TEXT, True); End IF; END; ]]> </transaction> </sql> </target>

26 SQL project release scripts scripts target <target name="release scripts" depends="jdbcsetup"> <! prompt for ITT ticket number(s) > <input message="enter ITT Ticket number(s) (without prefix ITT) separated by commas:" addproperty="itt.numbers"/> <! For each ticket attempt to find and execute an sql script, a procedure, and/or build script based on ITT number and environment. > <for list="${itt ${itt.numbers} numbers}" param="itt itt.number number"> <sequential> <antcall target="execute script" > Call to run SQL <param name="file" value="${cvs.dir.scripts}/itt@{itt.number}.sql"></param> command <param name="itt" value="itt@{itt.number}"/> </antcall> <antcall target="execute procedure" > Call to run SQL procedure <param name="file" value="${cvs.dir.scripts}/itt@{itt.number}.prc"></param> <param name="itt" value="itt@{itt.number}"/> </antcall> <antcall target="execute build script"> <param name="build.script.file" value="${cvs.dir.scripts}/itt@{itt.number}.xml"></param> Call to run ant <param name="itt" value="itt@{itt.number}"/> build script </antcall> </sequential> </for> </target>

27 SQL project execute script target <target name="execute script" depends="check for environment file"> <available file="${environment.file}" property="file.exists"/> <if> <equals arg1="${file.exists}" arg2="true"/> <then> <echo>execute script in file fl ${environment.file}.</echo> fl <antcall target="execute sql command"> <param name="file" value="${environment.file}"/> </antcall> </then> </if> Call to run SQL command </target>

28 SQL project execute sql command command target <target name="execute sql command" depends="jdbcsetup"> <fail unless="jdbc.url"/> <echo>execute sql in file ${file}</echo> <sql driver="oracle.jdbc.oracledriver" url="${jdbc.url}" userid="${jdbc.user}" password="${jdbc.password}" classpathref="sql.classpath" keepformat="yes"> <transaction src="${file}"/> </sql> </target> l "${ db l}" JDBC call to Oracle for SQL command execution

29 SQL project execute procedure target <target name="execute procedure" depends="check for environment file"> <available file="${environment.file}" property="file.exists"/> <if> <equals arg1="${file.exists}" arg2="true"/> <then> <echo>execute script in file ${environment.file}.</echo> <antcall target="execute plsql code"> <param name="file" value="${environment.file}"/> </antcall> </then> </if> Call SQL script execution </target>

30 SQL project execute build script target <target name="execute build script"> <available file="${build.script.file}" property="file.exists"/> <if> <equals arg1="${file.exists}" arg2="true"/> <then> <echo>execute script in file ${build.script.file}.</echo> <ant antfile="${build.script.file}" target="execute" inheritrefs="true"/> </then> </if> Execute ant build script </target>

31 Software Development and Deployment In an Oracle Environment Build and Deploy steps Development server Checkout Build / verify Tag Release (assign QA build ID) QA server Deploy release and execute scripts Validate Approve for Production Production server Production server Deploy release and execute scripts Verify

32 Software Development and Deployment In an Oracle Environment Ant Build Targets checkout tagrelease deployrelease checkout Call individual project deployrelease targets compilepackage execute-plsql-code recompile-invalid-packages execute-plsql-code check-for-compilation-errors release-scripts execute-script execute-sql-command execute-procedure execute-plsql-code execute-build-script