clafonta/mockey

Mockey is a tool for testing application interactions over http, with a focus on testing web services, specifically web or native applications that consume XML, JSON, and HTML. Mockey's purpose is to be a simple front end to writing mock-test-responses to the file system for persistence to git.

README

What is Mockey?

A testing tool, used to mock end point web services for the purpose of testing web service client applications.

Features

• Use Mockey as a proxy to a real service, to inspect request and response messages
• Set up Mockey to go through a corporate proxy server, to reach an endpoint web service
• Support for HTTP/s interactions (even if your corporate proxy server has https as an endpoint web service)
• Ability to 'play back' conversations for when endpoint services are not available
• Ability to run EVERYTHING in a sandbox - your application and the endpoint webservices your application is consuming.

What is Mockey not good at?

• Large payloads used in conversations, e.g. 10MB per message
• Transport protocols other than HTTP, e.g. FTP.
• Complicated conversations e.g. if X, then call this database, else if Y, call 'rake FOO', else kick-off-Maven.
• Solving everything

Getting Started - Quick

Pre-built jars are located here: https://github.com/clafonta/Mockey/wiki/Downloads

To start:

java -jar Mockey.jar

Mockey.jar is an executable jar file, which will start Mockey within a Jetty container and fire up your browser pointing at the defaults (port 8080, /home). You may need to 'click' refresh on your Browser to see the home page.

To build one locally, you'll need Ant and then do the following:

cd MOCKEY_HOME // root directory of where you checked out Mockey.

ant dist

After a successful build, do the following to start the app:

cd dist

java -jar Mockey.jar

For startup options:

java -jar Mockey.jar --help

For those who prefer to run Mockey in a Tomcat instance, you'll need to build the app:

ant webapptomcat

This will build a WAR file, which you can drop into Tomcat and run. You can set the location of Mockey definition file repot as follows:

export JAVA_OPTS="-DmockeyDefinitionsRepoHome=/Users/your-username/some-directory"

When Mockey starts up in Tomcat, it will look for the 'mockeyDefinitionsRepoHome' property and read write needed files in that directory. If not defined, it will read write files in the default user directory that Tomcat is started with.

mockey's Issues

CSS - Laborious

Move your laborious CSS into it's own directory, and anything custom goes into a custom directory, so you don't have to repeat CSS changes per laborious project.

In history list, add ability to insert a comment and marker between history rows.

"I don't want to delete a long on-going history list of items, and I want to know when my next round of testing started, and I want to "comment" on things" - Rob

Rob would like to not flush history all the time.

Don't hide tags

Remove the show/hide tags - keep tags always displayed which means, information is always "in your face", encouraging users to keep things clean.

Flush link leaves the query string DELETE on the URL, so next time, the user refreshes, it deletes!

Delete and either redirect to the home page or do something else, so REFRESH doesn't delete the settings on the "All Services" page.

unable to save scenario from history.

After a few proxy captures in history, try to 'save as a scenario'. You should see an error caused by a missing 'scenario name'. Fix this.

Add search/filter. via Lucene

I would like to filter/search on the homepage. Service list is getting looonnng..... Please fix.

On Main Page, Add AJAX toggle between Static or Proxy.

To make it easier to quickly update the list.

On Main Page, Add AJAX toggle between Static or Proxy.

To make it easier to quickly update the list.

order list of services alphabetically

in addition to filter box to quick jump to the service in the master list

Mockey should be able to see other Mockies and clone their configuration

Maybe via Bonjour.

set up REGEX for MATCH

...when doing response type Dynamic.

Support for other character encodings than ISO-8859-1 for responses

I need support for UTF-8 for my project. I'm hacking around it by the doing the following (not sure all of this is needed):

I needed to return utf-8 json response so I hacked together the following fix. I'm sure there is probably a better way to do this and this may not solve updating a utf-8 response via the UI (header.js hardcodes the character encoding so it will probably mess up UTF-8 responses when displaying and updating responses).

Also the code for detecting the charset and extracting formt he content-type header could probably be a little more robust I guess.

1. creating an XML service import file with content-type set to application/json;charset=utf-8
2. adding application/json;charset=utf-8 to the setup_service.jsp's options.
3. adding code to the ResponseServlet.java to check for charset set on the content-type and if it is there attempting to use it instead(code inserted around line 110):

            //check content type for charset and try to use that if its there...
    //example: application/json;charset=utf-8
    //should use the charset "utf-8"
    String charSet=HTTP.ISO_8859_1;

    try {
        if(service.getHttpContentType()!=null) {
            final String contentTypeUpper=service.getHttpContentType().toLowerCase();
            int charsetIndex=contentTypeUpper.indexOf("charset=");

            if(charsetIndex>=0) {
                charSet=contentTypeUpper.substring(charsetIndex+"charset=".length());

                //make sure it is a valid charset
                Charset.forName(charSet);
            }
        }
    } catch(Exception e) { 
        charSet=HTTP.ISO_8859_1;
    }

    resp.setCharacterEncoding(charSet); // "UTF-8");
    resp.setContentType(service.getHttpContentType());
    if (!(service.getServiceResponseType() == Service.SERVICE_RESPONSE_TYPE_PROXY)) {
        resp.setContentType(service.getHttpContentType());
        byte[] myCharSetBytes = response.getBody().getBytes(charSet);
        new PrintStream(resp.getOutputStream()).write(myCharSetBytes);
        resp.getOutputStream().flush();
    } else {
        resp.setStatus(response.getStatusLine().getStatusCode());
        response.writeToOutput(resp);
    }

Use the last part of the real service url instead of "Autogenerated Service" wherever possible.

A service with a url like http://localhost:8080/service/http://host/Service/Action should be identified as "Action" in mockey's UI.

cannot proxy to service over SSL with self-signed cert

Proxying to a service using SSL with a self-signed certificate results in an error: "Proxy settings are NOT ENABLED". That's misleading, given that proxying a service and using an HTTP proxy for outbound requests are unrelated. The actual error is an SSLPeerUnverifiedException, thrown from httpclient.execute() in ClientExecuteProxy. Unfortunately, that gets caught and Mockey reports a problem with the proxy configuration. The SSL error is logged, but it's easily missed...

At minimum I'd like to see the problem surfaced in the service history (rather than mis-diagnosed as a problem with the HTTP proxy config). Better yet would be a way to allow self-signed certs, as Mockey is currently unusable in this situation (and I don't have control over the remote service to either allow HTTP requests or replace the self-signed cert).

Service Definitions needs to be a project file, not just in an XML.

Mockey should start to manage configurations in a 'mockey-project' folder. The service definitions XML lives in that folder, along with all other project related files.

Dynamic Scenarios - check BODY and Query Params

Looks like Mockey only looks in the BODY for a match, and not the query params. Investigate please.

Figure out how to pass the xml file on the command line

This would be pretty hard, but if we could figure out how to pass the mockey file we want to load on the command line, that would be really cool. Then you could just save off different scenarios as different xml files and then start up mockey with the pre-configured set you want.

Pin the services detail view to the top of the browser viewport

If there is a very long list of services, when you click on one to see the details, you shouldn't have to scroll all the way to the top to see the details.

history items within the last minute are reported as "About 1 hour ago".

Copy all headers and cookies, allow user to manipulate these values too.

Originated from issue #45. "Really, I'd like to see it return all of the headers and cookies too and be able to setup services / scenarios that let me copy these values from the service history".

Example recording should say [Context Root] not Mockey

Should be

Since the examples have no context root in them.

Post an API

Next to or within the Help section, post the API and 'how-tos' to configure Mockey from outside the browser. Here's a story:
Need: have ant make an http request and set a Service Plan
Problem: what http request does Ant make to ensure "Gold Member" settings are set?

Creating a Scenario from Service History request fails in Firefox 4

Javascript object names are incorrect on lines 170 and 171 of web\WEB-INF\common\inc_scenario_create_dialog.jsp.

old lines read:
responseMessage: responsemsg.val(), universalErrorScenario: universalerrorscenario.val(),
errorScenario: errorscenario.val() } ,function(data){

lines with fixed object names:
responseMessage: responsemsg.val(), universalErrorScenario: universal_error_scenario.val(),
errorScenario: error_scenario.val() } ,function(data){

set plan feature is broken. I am not sure we need it anymore.

do we need this? export and upload of the different def file is good enough. but I do want "set all this to proxy or static" feature.

JMS support

Add JMS support, not just HTTP

Filter history with NOT

Ability to view JSON scenarios in a nice formatted view for easier view.

Even when formatted, post restart or persisting the JSON to file, on next view, the format is lost. It doesn't matter if formatted is lost when persisted, but it would be nice to view with "formatted?" option.

Move Proxy On/Off indicator

Appending On/Off indicator to the Proxy menu name is flaky - it makes the menu do weird things. Maybe, try floating in absolute position over the Proxy menu item?

Make service urls replaceable/tuneable somehow....

Service urls are usually environment specific, example:

https://qa1.test.com/veryspecialservice
https://qa2.test.com/veryspecialservice
...

To point mockey at that service, you'd use a URL like this:

https://mockeyserver:8080/service/https://qa1.test.com/veryspecialservice

But then if you record a bunch of interesting responses that you want to share, they are all pointing at qa1. When it comes time to test against qa2, new services are generated and the old responses aren't copied.

It should be possible to switch the "real" urls that a group of services point to without disturbing the service matching that is done.

history page - toggle text.

When "view" is clicked, toggle text to "hide". Don't always show both. Same with "tag". Don't we need an "untag"? Chad is lazy.

Bug with port handling in com.mockey.model.Url

Services are having colons replaced with semicolons fix below seems to work fine (assuming that the issue is caused by a typo):

public static String getSchemeHostPortPathFromURL(String validUrl) throws MalformedURLException {
    URL aURL = new URL(validUrl);
    String port = "";
    if(aURL.getPort() > -1){
        //port = ";"+aURL.getPort();
        port = ":"+aURL.getPort();
    }
    String schemeHostPortPath = aURL.getProtocol() + "://" + aURL.getHost() + port + aURL.getPath();
    return schemeHostPortPath;
}

add "last accessed time" to the services list

it would be convenient to scan the services list and see the service that was just accessed. Maybe a polling ajax call so it updates every 10 secs or something.

On History Page, add S or P flags.

There's no immediate method or visual flag to tell the user that the service was in Proxy (P) or Static (S).

Set-Plan via History view

Within the history view, you should be able to set a Plan based on a history path. Save each Response to each Service as a Scenario.

Search is broken. Fix it!

On the home page, searching for a service and/or scenario leads to a result set with broken links. It sometimes works - make sure you're escaping HTML characters.

Consolidate modal dialogs.

Mockey uses two types of modal dialogs: JQI and JQueryUI. We like the JQueryUI and get rid of JQI. This work is related to CSS - Laborious

the "proxy" tab should indicate the status of the proxy configuration

maybe a small word that is either "(on)" or "(off)" or an image of a light switch or something.

When acting as a proxy, mockey return proxied service's status code

Really, I'd like to see it return all of the headers and cookies too and be able to setup services / scenarios that let me copy these values from the service history, but all I'm suggesting be fixed in the short term is that the http status code of the proxied service be passed to client instead of always returning 200 OK.

Proposed fix in com.mockey.server.ResponseServlet (line 115) add line:

resp.setStatus(response.getStatusLine().getStatusCode());

else branch now reads:

           else {
        resp.setStatus(response.getStatusLine().getStatusCode());
        response.writeToOutput(resp);
    }

thanks.

changing from proxy to static doesn't set the right hilight in the services list

1. select a service that is marked with "P"
2. change it to be a static service
3. the "P" highlight goes away, but the "S" highlight does not appear.

Handle a 15 MB message

Yes, the server is returning large payloads and Mockey can't manage this all in an XML. What to do? Some ideas: if the message payload is too large, then write to the file system but keep META in the service-definitions.xml.

What about viewing history? Mockey's History Servlet/Service should be able to break it down, like 'tail'.

Http header response is not being persisted in Export/Import.

Auto-generated services should default to 0 hangtime

Defaulting to 500ms hangtime is kind of annoying and we should stop it.

Support URLs which require basic authentication

ie 8 is fine. Can we remove the "not designed for ie" message ?

Add a button to "services" screen to "proxy all" or "static all"

There should be a way to set all the services to be either proxy or static with one click.

color scheme

we need a refresh to the color scheme

Documentation needed

Add a new documentation section for the service API that accepts query parameters and responds with JSON.

Add some inject feature for real URLs or 'swap

If you have 20 services and 20 http://xxxx.qa1.com urls, and you want to 'swap' qa1 for qa2. The work around is export your Definitions file, find and replace QA1 for QA2. But that can be tedious (right?). Maybe not.

On Main Page, Add AJAX toggle between Static or Proxy.

To make it easier to quickly update the list.

Add ability to follow 302

follow 302