6

Source code analysis - Teaser

by Riverside Software


Guess what's coming next...
0

OpenEdge class documentation

by Riverside Software
Thanks to ConsultingWerk, it's now possible to generate an HTML documentation for OpenEdge classes. An example can be downloaded here. Thanks Mike and Sebastian for sharing this code.

A PCT task has been created, to be able to generate the documentation as part of your continuous integration process.
0

Javadoc-like documentation for OpenEdge classes

by Riverside Software
Riverside Software is proud to announce the availability of a new task in PCT to automatically generate Javadoc-like documentation from your OpenEdge classes. OK, I'm lying, this is not Javadoc-like at the moment, it's just XML ! Conversion from XML files to nice looking HTML pages is being worked on, and should be available soon.

This task is based on the implementation of the ABL parser included in OpenEdge Architect, and this first successful attempt of source code parsing offers an extremely large range of possibilities in source code analysis (conformance to coding standards, potential problems, deprecated features, ...).

Be sure to read the requirements for the new ClassDocumentation task, and leave comments or contact us directly !
0

Webspeed setup on Tomcat

by Riverside Software
The latest versions of OpenEdge allow simple serialization of temp-tables and prodatasets to JSON, and in this context, Webspeed may become more and more popular as it can serve the JSON result directly, without having to rely on Java/ASP/Whatever.
As I'm mainly working with Java, I always have a servlet container ready to run. But the Progress documentation doesn't mention Tomcat as a deployment plaftorm ; here is this guide !

Step 1 : Download Tomcat

This guide is for Tomcat 6, but any other version should work. So grab Tomcat from http://tomcat.apache.org/download-60.cgi and install it (for the Windows installer version) or extract it (for the standalone ZIP file).
In this documentation, $CATALINA_HOME will represent the installation path.

Step 2 : create a new webapp

Create a new directory in $CATALINA_HOME/webapps. This directory has to called webspeed followed by the version number, i.e. if you're running OpenEdge 11.0, the directory will be $CATALINA_HOME/webapps/webspeed110.
In this documentation, $WEBAPP will represent this directory
In this directory, create a subdirectory WEB-INF (case-sensitive).

Step 3 : copy static files

Copy the content of $DLC/webspeed to $WEBAPP, then copy $DLC/bin/cgiip.exe to $WEBAPP/WEB-INF/cgi (create a subdirectory for it).

Step 4 : create web.xml

The file web.xml is the webapp description file : 
<?xml version="1.0" encoding="ISO-8859-1"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   version="2.5"> 

     <servlet>
        <servlet-name>cgi</servlet-name>
        <servlet-class>org.apache.catalina.servlets.CGIServlet</servlet-class>
        <init-param>
          <param-name>debug</param-name>
          <param-value>0</param-value>
        </init-param>
        <init-param>
          <param-name>cgiPathPrefix</param-name>
          <param-value>WEB-INF/cgi</param-value>
        </init-param>
        <init-param>
          <param-name>executable</param-name>
          <param-value></param-value>
        </init-param>
        <init-param>
          <param-name>passShellEnvironment</param-name>
          <param-value>true</param-value>
        </init-param>
        <load-on-startup>4</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>cgi</servlet-name>
        <url-pattern>/cgi/*</url-pattern>
    </servlet-mapping>
</web-app>

Step 5 : privileged application

Create an XML file in $CATALINA_HOME/conf/Catalina/localhost, with the same name as the webapp directory : if you created in step 2 a directory called webspeed110, then create webspeed110.xml.
The content of this file is :
<Context privileged="true" />

Step 6 : configure your webspeed broker

This is OpenEdge configuration, and it won't be covered here...

Step 7 : play !

Start Tomcat, and go to http://localhost:8080/webspeed110/cgi/cgiip.exe/WService=wsbroker1/workshop
This URL assumes that you're running with the default Webspeed broker wsbroker1.

Bonus step 1 : URL rewriting

Using URL like /webspeed110/cgi/cgiip.exe/WService=wsbroker1/programName can be dangerous, as it gives users the knowledge that CGI is being used and active, allows anybody to change the broker name, and so on...
A Tomcat filter is already available to rewrite URL, available here.
To setup this filter, you'll need to create a new directory $WEBAPP/WEB-INF/lib and drop this JAR file.
Update your web.xml file to declare this filter :
<filter>
        <filter-name>UrlRewriteFilter</filter-name>
        <filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class>
        <init-param>
            <param-name>confReloadCheckInterval</param-name>
            <param-value>0</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>UrlRewriteFilter</filter-name>
        <url-pattern>/*</url-pattern>
        <dispatcher>REQUEST</dispatcher>
        <dispatcher>FORWARD</dispatcher>
    </filter-mapping>
Then create a file urlrewrite.xml in $WEBAPP/WEB-INF, with this content :
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE urlrewrite PUBLIC "-//tuckey.org//DTD UrlRewrite 3.2//EN"
        "http://tuckey.org/res/dtds/urlrewrite3.2.dtd">
<urlrewrite>
    <rule>
        <from>/cgiip/(.*)</from>
        <to>/cgi/cgiip.exe/WService=wsbroker1/$1</to>
    </rule>
 
    <!-- default rules included with urlrewrite -->
    <rule>
        <note>
            The rule means that requests to /test/status/ will be redirected to /rewrite-status
            the url will be rewritten.
        </note>
        <from>/test/status/</from>
        <to type="redirect">%{context-path}/rewrite-status</to>
    </rule>
    
    <outbound-rule>
        <note>
            The outbound-rule specifies that when response.encodeURL is called (if you are using JSTL c:url)
            the url /rewrite-status will be rewritten to /test/status/.
 
            The above rule and this outbound-rule means that end users should never see the
            url /rewrite-status only /test/status/ both in thier location bar and in hyperlinks
            in your pages.
        </note>
        <from>/rewrite-status</from>
        <to>/test/status/</to>
    </outbound-rule>
</urlrewrite>
Restart Tomcat, and then you'll be able to access the workshop at http://localhost:8080/webspeed110/cgiip/workshop

Bonus step 2 : cgi.bat (and a reminder for myself)

<?xml version="1.0" encoding="ISO-8859-1"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   version="2.5"> 

     <servlet>
        <servlet-name>cgi</servlet-name>
        <servlet-class>org.apache.catalina.servlets.CGIServlet</servlet-class>
        <init-param>
          <param-name>debug</param-name>
          <param-value>0</param-value>
        </init-param>
        <init-param>
          <param-name>cgiPathPrefix</param-name>
          <param-value>WEB-INF/cgi</param-value>
        </init-param>
        <init-param>
          <param-name>executable</param-name>
          <param-value>c:\windows\system32\cmd.exe</param-value>
        </init-param>
        <init-param>
          <param-name>executable-arg-1</param-name>
          <param-value>/c</param-value>
        </init-param>
        <init-param>
          <param-name>passShellEnvironment</param-name>
          <param-value>true</param-value>
        </init-param>
        <load-on-startup>4</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>cgi</servlet-name>
        <url-pattern>/cgi/*</url-pattern>
    </servlet-mapping>
</web-app>
With cgi.bat like that :
@echo off
set DLC=C:\Progress\OPENED~1.5
set PROMSGS=%DLC%\promsgs
set WRKDIR=%TEMP%
REM 3055 is default port of wsbroker1
%DLC%\bin\cgiip.exe localhost 3055
1

PUG Challenge 2011 - Amsterdam

by Riverside Software
First of all, many thanks to the PUG committee for setting up such a great event.
Here are my presentations about continuous integration and deployment to vmware/EC2.
2

Progress Revolution

by Riverside Software
I'm currently attending Progress Revolution  in Boston, and waiting for the first session to start ! People who want to discover continuous integration and deployment automation should really attend Mr Preece session "A 21st century revolution in development methods" today afternoon. I'll attend this session and will be available with Brian Preece to answer questions.
1

IE9 is out

by Riverside Software
Nice landing page ! But it seems that UTF-8 is still a problem in 2011...
0

PUG UK & Ireland - Spring conference

by Riverside Software
For those who were not able to attend my session at the latest PUG Challenge, I'll do it again in Birmingham on Wednesday 23rd March 2011. As a reminder, my session is about build automation and continuous integration in an OpenEdge environment. Target audience is mainly developers and architects, but managers willing to know how to keep developers working on real code and not on useless things should attend this session !


PUG UK & Ireland - Spring conference
0

PCT 0.18 is released

by Riverside Software
A regression was introduced in 0.17, released a few days ago ; incremental dumps were only working on 10.2A+. A bug fix release (named 0.18, but could have been named 0.17.1) was released yesterday. Download it from Google code !
5

Return values, exceptions and error status shouldn't be left unread...

by Riverside Software
I just lost three hours. Not really the end of the world, but really annoying when you find it was a stupid mistake, combined with badly written code.
I was working on an enhancement for PCT, allowing database connections to be made either with the standard dbName/dbDir/hostName/portNumber attributes, or with just a paramFile attribute. Just a few lines of code to change so that aliases are not broken, a few new test cases, done in half an hour, everything's working. In fact, no, database connections are done differently with background compilations. Spent two minutes correcting this mistake, copied/pasted test case for this task, and boom... Ran tests again, it works... Ran again, boom...
Test cases working half the time when you're working with thread and forked processes communicating with a main server usually mean that you're running into synchronization issues. Just in case, I take "Java concurrency in practice" from my bookshelf, ready to debug this problem. Adding some debug messages in OpenEdge sessions, trying different combinations, re-doing a complete schema of this inter-process and inter-thread communication, I'm unable to find the cause of the problem.
Until I find the "Ha ha" ! My test case is creating a Progress database, and two spawned sessions are compiling programs. But I'm running those sessions with single user connections. And there's NO ERROR HANDLING FOR CONNECTION FAILURES !!! So depending on the mood of my computer, compilation was sometimes done by the first thread, and sometimes by the second thread. No problem for the first thread, DB connection was OK, but the second thread was never able to connect the database (and so compile programs). But I never got a warning or error message saying that it wasn't able to connect...

Result : just lost time, and I have to modify error handling so that DB connections are gracefully handled. Connection failure was handled in OpenEdge, pushed back to the first OpenEdge procedure, pushed back to the Java thread, and there it was dropped silently.

Error status and exceptions are not there to bother the programmer, it's just that something is wrong. So unless you're absolutely sure that you want to skip this error (and you should document that in your code), just let the exception bubble up (with a RuntimeException if possible in Java) or don't use NO-ERROR in Progress if you don't know what to do with it.

Theme by allblogtools.com | Blogger Templates