Integrating Software AG Designer and webmethods Asset Build Environment with Subversion

Transcription

1 Integrating Software AG Designer and webmethods Asset Build Environment with Subversion Setup and Connection Cheat sheet Author: Wayne Leishman Version 1.0 4, February, /13/ Software AG. All rights reserved.

2 DOCUMENT NAME Date Table of contents 1.0 Introduction Out of Scope Install Subversion Server (v ) Install SVN ANT (v 1.3.1) Create a Subversion Repository Download Subversive Plug-in & Connectors to use in Designer Setup Designer to connect to Subversion Create Local Service Development Project Setup and Use webmethods Asset Build Environment Connecting webmethods Deployer to Asset Build Environment For more information 21..on Subversion (SVN) 21..on Designer Local Service Development 22..on webmethods Deployer (using Repository-based deployment) Software AG. All rights reserved.

3 1.0 Introduction This document summarizes how to : configure Software AG Designer (9.7) local service development to connect to a Subversion (v ) repository. configure webmethods Asset Build Environment (9.7) to connect to the Subversion repository, automatically checkout from Subversion and do a build. connect webmethods Deployer (9.7) to the Asset Build Environment repository. The document covers the following steps : Install Subversion Server (v ) Install SVN Ant Create a Subversion Repository Download Subversive Plug-in & Connectors to use in Designer Setup Designer to connect to Subversion Create Local Service Development Project Setup and Use webmethods Asset Build Environment Connecting webmethods Deployer to Asset Build Environment Note: The Local Service Development plugin is part of Software AG Designer Workstation which provides client side integration with various Version Control Systems (including Subversion). You will need an IS Development license to have a locally installed Integration Server to use with Designer Workstation. Disclaimer : This document will give you enough to get started configuring and using Designer local service development and webmethods Asset Build Environment with Subversion. It is not meant to be a comprehensive guide on everything. For more details, refer to the section at the end of this document to find out where to get more information. 1.1 Out of Scope In depth coverage of Subversion (svn) is not covered. Also, this document does not cover how to use the VCS (Subversion) client within Designer. 2.0 Install Subversion Server (v ) 1. Download Subversion Server (this example uses CollabNet Subversion server v1.7.14). The install exe is: CollabNetSubversion-server Win32.exe 2. Create the following directory for your SVN repository: C:\svn_repository 3. There are many ways to provide subversion servers; this install is very straight forward. Run the installer (CollabNetSubversion-server Win32.exe). The installer for this version has been saved in the E ToBeInstalledOnVM folder: NOTE: You do not have to install Apache(MOD_DAV_SVN) Software AG. All rights reserved.

4 Software AG. All rights reserved.

5 4. The installer will automatically include the Subversion server in your PATH environment variable (C:\Program Files (x86)\collabnet\subversion Server) The CollabNet Subversion svnserve service will be setup in Windows. You can decide to set this manually (it is set to Automatic by default). Start this service: Software AG. All rights reserved.

6 3.0 Install SVN ANT (v 1.3.1) SVN Ant ( is required by the webmethods Asset Build Environment for checkout from Subversion. We will use v Download and extract the zip file into a directory that can be accessed by the Asset Build Environment. In this example extract it to: C:\svnant Create a Subversion Repository 1. Create an initial repository under C:\svn_repository. In this example we will create a repository called wmsvnrepo. Obviously in your real environment you can create a repository with any name. From the command line: a. cd c:\svn_repository b. Type: svnadmin create wmsvnrepo 2. Add SVN users into the repository passwd file. We will add a user call wmrepouser1 To do this, add the following line to C:\svn_repository\wmSVNrepo\conf\passwd wmrepouser1 = manage 3. Uncomment lines in C:\svn_repository\wmSVNrepo\conf\svnserve.cnf auth-access = write password-db = passwd Note: this is basic Subversion security. For more in depth security options on Subversion, refer to the documents listed at the end. 5.0 Download Subversive Plug-in & Connectors to use in Designer 1. In Designer we will use the Subversive plug-in for Subversion. You can download the plug-in in a zip file here: er/subversive i zip Save the zip file. We will install it in Designer later. 2. Download the Subversion Connectors to use in Designer. You can download the connectors from : Save the zip file. We will install the plug-in in Designer in the next section. 6.0 Setup Designer to connect to Subversion 1. For local development make sure you set the locking mode extended setting on the Integration Server to system. Use IS Admin UI to set: watt.server.ns.lockingmode=system 2. Start your Subversion server. If running on Windows, start: Software AG. All rights reserved.

7 3. Next, install the necessary plug-ins to Software AG Designer to support Subversion. Start Designer. Verify that no plug-ins for Subversion are installed yet. This will also be good practice for you to get acquainted with locating versions and installed plug-ins in Designer. a. From the main menu, go to Help About Software AG Designer. Then click on Installation Details. b. Click on the Plug-ins tab then on the Provider column to sort all the entries (it may take a few seconds for the window to fill in all the plugins). Then you ll see a complete list of all the Software AG features installed and their versions. Scroll through the list and make sure the Subversion plug-in is not installed yet. c. Close this window and click OK to close the About Software AG window. 4. In this example we will turn off updates from Internet sites. You can enable this later after we install the plug-in. a. Go to Window Preferences from the main menu. Then open the section under Install/Update Available Software Sites. b. Make a note of all sites that are accessed over http ( ) AND enabled (checked). Then disable (Un-check) all sites accessed over http. You do not have to un-check sites prefixed with file://. Note: at the end of this section you can re-enabled the sites you disabled. c. When you are done click OK to close this window Software AG. All rights reserved.

8 5. Install the Subversive plug-in. a. Go to Help Install New Software. The Available Software window will open. Click Add b. From the dialog box, click Archive button then navigate to location where you downloaded the file named: Subversive I zip Select the file. Click Open. Click Ok. Click OK 6. The archive will be inspected, and then you ll see a list of all the packages in the archive. a. Select only the item listed as Subversive SVN Team Provider Plugin b. Un-check the box next to Contact all update sites during install to find required software. In your real environments you may leave this checked for this example we don t need to look for newer versions Software AG. All rights reserved.

9 c. Leave all other options default and click Next>. d. You ll see a screen asking you to review the components to be installed. Click Next> again, then you ll be taken to a window asking you to accept the license terms. Click on the radio button I accept the terms of the license agreement, then click Finish e. Once Designer is done installing the plug-in, it will need to restart, select Restart Now from the resulting dialog box. 7. Next we need to install the SVN Connectors library. This library implements the ability to connect to a subversion repository; either using native Windows code (JavaHL) or native Java libraries (SVNKit). We ll use the SVNKit libraries. a. Go to Help Install New Software. Click Add then Archive. b. Navigate to location where you downloaded the file named: Subversive-connectors-allplatforms I zip Select the file, click Open. Click OK. c. Once again, be sure to un-check the box next to Contact all update sites.. From this archive, expand the top level Subversion SVN Connectors and only select the two SUB Entries: Subversive SVN Connectors and SVNKit Implementation (Optional) (Do not select the box beside the top-level Subversive SVN Connectors See picture below) Software AG. All rights reserved.

10 Then click Next> twice, accept the license terms, and click Finish. You may see a Security Warning dialog box. Click OK and let the install continue. Click Yes when asked if you want to restart Designer. 8. Once Designer restarts, close the Welcome view, and go to Window Open Perspective Other. Scroll down the list and choose SVN Repository Exploring. That perspective will open, allowing you to connect to a svn repository, which we ll do in an upcoming section. 9. In Designer changes a couple preferences specifically for local development a. Configure your workspace to be refreshed automatically by selecting the Refresh using native hooks or polling or Refresh automatically check box in Window > Preferences > General > Workspace. b. Remove.BAK and.bak from the list of resource name patterns to exclude from the VCS. To do this, make sure.bak and.bak check boxes are NOT Selected in Window > Preferences > Team > Ignored Resources Software AG. All rights reserved.

11 7.0 Create Local Service Development Project Make sure you have completed the previous install/configuration steps. For details on local service development with Integration Server, refer to section Create Local Service Development Project the Service Development Help doc here: 1. In the Service Development perspective in Designer, right-click the package for which you want to create a local service development project and select Create Local Service Development Project. Designer creates the local service development project and displays the Share Project wizard. 2. From the list of VCS client plug-ins, select the VCS client that you want to use to share the new project. In this example, select SVN. Click Next. 3. The screens that appear next are specific to the SVN client that you selected. Enter the relevant information and credentials of your VCS client. For our example repository enter the following: For URL enter the location of the Subversion repository we setup: svn://localhost:3690/wmsvnrepo For User, enter: wmrepouser1 For Password, enter: manage Software AG. All rights reserved.

12 Click Next. With Simple Mode selected, click Finish. Enter something in the commit comment field and click OK Software AG. All rights reserved.

13 Note: this example does not put the IS package (project) into a repository folder structure. Here s an example of a folder structure in your repository to hold webmethods assets (e.g. IS packages, etc ) <wm project name 1> branches tags trunk <product folder> <product folder> For example: Software AG. All rights reserved.

14 4. Designer creates a project in your workspace with the same name as the package. In the Package Navigator view, the icon representing the package that you have shared to the VCS changes to showing that the package is now shared with the VCS product (in this case Subversion). The package and the elements contained in the package will now be available in the VCS. To make changes to anything in your package you will have to check them out of the VCS (covered below). 5. Open the SVN Repositories view in Designer. You should see the package you just stored in the SVN repository called wmsvnrepo: Software AG. All rights reserved.

15 As mentioned in the introduction, for more information about how to use the VCS (Subversion) with Designer local service development, refer to the Service Development help doc. At this point the normal development lifecycle will take place (checkout from VCS, edit, create, make changes, unit test, debug, checkin to VCS, etc ) Software AG. All rights reserved.

16 8.0 Setup and Use webmethods Asset Build Environment In this section, you will see how to configure the Asset Build Environment to extract the IS assets automatically from the VCS (Subversion). After this is done you can use webmethods Deployer to push it to the target environment(s). 1. Create a directory for the Asset Build. Open a File Explorer, and create the following directory and subdirectories: Note: this is just an example folder structure. You can come up with your own naming standards for ABE. 2. You will next configure the Asset Build Environment before running the build. The Asset Build Environment is located under: <SAG Home>\common\AssetBuildEnvironment Use Windows Explorer and navigate into the directory <SAG Home>\common\AssetBuildEnvironment\master_build a. Open the files build.properties and build-source-checkout.xml in Notepad++ or the text editor of your preference. You will notice build.xml is the main Ant build file. It references build.properties and buildsource-checkout.xml. We ll make our changes in the build.properties and build-source-checkout.xml files. In build.properties change the following properties to the listed values:

17 Property build.output.dir build.source.dir enable.checkout enable.archive build.archive.dir enable.build.is build.log.enable build.log.filename Value c:/abe/build c:/abe/svncheckout/is true true c:/abe/archive true true c:/abe/logs/build.log Be sure to save your changes b. Set the following properties in the build-source-checkout.xml file and then save your changes: Property svn.jars.dir svn.user svn.password svn.url Value c:/svnant1.3.1/lib wmrepouser1 manage svn://localhost:3690/wmsvnrepo Note: this URL can be used to point to any specific folder within the repository. build.checkout.dir c:/abe/svncheckout/is Software AG. All rights reserved.

18 c. SVN ANT v1.3.1 does not fully support Subversion 1.7.x, but there is a way to make it work by changing javahl to false and setting svnkit to false. You will also have to implement the svnsetting parameters because some values are deprecated. To do this, delete the following XML highlighted within the rectangle: and replace it with the following XML: <svnsetting javahl="false" svnkit="false" username="${svn.user}" password="${svn.password}" id="svn.settings" /> <target name="checkout" depends="clean" description="check out all the sources from version control"> <svn refid="svn.settings"> <checkout url="${svn.url}" revision="head" destpath="${build.checkout.dir}" /> </svn> </target> Save your changes. 3. When the build runs the source will be extracted FROM the Subversion repository location svn://localhost:3690/wmsvnrepo TO the file system directory: c:/abe/svncheckout/is You ll be able to inspect the build results in c:/abe after running ABE. 4. It s time to run the build: open a command prompt then cd into <SAG Home>\common\AssetBuildEnvironment\bin Type build.bat and press Enter. ( The build.bat uses Ant, and Ant uses build.xml for the build settings ) You will see the output of the build in your command window. If everything works fine you will see a message at the end saying: BUILD SUCCESSFUL Software AG. All rights reserved.

19 You can use Windows Explorer to see the results of the build. The IS package was checked out to the directory c:\abe\svncheckout\is The build output is under the directory: c:\abe\build (this location will become a Source Repository in Deployer). The build.log is under c:\abe\logs. 9.0 Connecting webmethods Deployer to Asset Build Environment This section will show you how to connect webmethods Deployer to your Asset Build Environment (file based) repository (where the build is located). This is use for Repository-based deployment instead of Runtime-based deployment. This section assumes you have configured Deployer to connect to your target servers. For details on Deployer, refer to the webmethods Deployers User s Guide. 1. Open webmethods Deployer in your browser. 2. Add a new source Repository. In the left nav bar, click Repository then Add Repository 3. Enter a Name for your Asset Build Enviroment repository. For example: MyABErepo and the File Directory as c:\abe\build and click the Configure button. You should see a message saying Repository MyABErepo was added. 4. You can then create a Deployer project of type Repository Software AG. All rights reserved.

20 5. After creating the deployer project, you can create a deployment set. Make sure you select your Asset Build Environment repository as the source for the deployment Software AG. All rights reserved.

21 6. Next, create the deployment Map so that you can select the target server(s). 7. Finally, you can create a Deployment Candidate, where you can first Simulate the deployment, or do the actual Deploy For more information..on Subversion (SVN) There are plenty of references on the web. The best place the start is: Get the free (PDF) book Version Control with Subversion: Read the FAQ: Software AG. All rights reserved.

22 ..on Designer Local Service Development For more info, refer to the section Using the Local Service Development Feature in the Service Development Help (v9.7) document here : Designer with VCS (Subversion) This document does not cover how to use the VCS (Subversion) client within Designer. For more information about how to use the VCS client with Designer local service development, refer to the following sections within the Service Development help doc: Adding Folders and Elements to the VCS Modifying Packages, Folders, or Elements in the VCS Checking Out an Element from the VCS Checking In Packages and Element to the VCS Getting the Latest Version from the VCS Getting a Specific Version from the VCS Copying Packages from the VCS to Integration Server..on webmethods Deployer (using Repository-based deployment) For more info, search for repository based deployment in the webmethods Deployer User s Guide (v9.7) document here : Software AG. All rights reserved.