added test for forwarded authentication (fails now) #55

clam/common/data.py

@@ -35,7 +35,7 @@
 import clam.common.util
 import clam.common.viewers
 
-VERSION = '2.2'
+VERSION = '2.2.1'
 
 #dirs for services shipped with CLAM itself
 CONFIGDIR = os.path.abspath(os.path.dirname(__file__) + '/../config/')

clam/config/forwardauthtest.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python
+#-*- coding:utf-8 -*-
+
+
+###############################################################
+# CLAM: Computational Linguistics Application Mediator
+# -- Settings --
+#       by Maarten van Gompel (proycon)
+#       http://ilk.uvt.nl/~mvgompel
+#       Induction for Linguistic Knowledge Research Group
+#       Universiteit van Tilburg
+#
+#       Licensed under GPLv3
+#
+###############################################################
+
+from clam.common.parameters import *
+from clam.common.formats import *
+from clam.common.converters import *
+from clam.common.viewers import *
+from clam.common.data import *
+from clam.common.digestauth import pwhash
+import sys
+
+REQUIRE_VERSION = 0.5
+
+# ======== GENERAL INFORMATION ===========
+
+#The System ID, a short alphanumeric identifier for internal use only
+SYSTEM_ID = "forwardauthtest"
+
+#System name, the way the system is presented to the world
+SYSTEM_NAME = "Text Statistics (CLAM Demo)"
+
+#An informative description for this system:
+SYSTEM_DESCRIPTION = "This webservice computes several statistics for plaintext files. It is a demo for CLAM."
+
+# ======== LOCATION ===========
+
+#The root directory for CLAM, all project files, (input & output) and
+#pre-installed corpora will be stored here. Set to an absolute path:
+ROOT = "/tmp/clam.textstats/"
+
+#The URL of the system
+PORT= 8080
+
+# ======== AUTHENTICATION & SECURITY ===========
+
+PREAUTHHEADER = 'REMOTE_USER'
+PREAUTHONLY = True
+
+#Users and passwords
+USERS = None
+
+#Amount of free memory required prior to starting a new process (in MB!), Free Memory + Cached (without swap!)
+#REQUIREMEMORY = 10
+
+#Maximum load average at which processes are still started (first number reported by 'uptime')
+#MAXLOADAVG = 4.0
+
+
+# ======== WEB-APPLICATION STYLING =============
+
+#Choose a style (has to be defined as a CSS file in style/ )
+STYLE = 'classic'
+
+# ======== ENABLED FORMATS ===========
+
+#Here you can specify an extra formats module
+CUSTOM_FORMATS_MODULE = None
+
+
+# ======== PREINSTALLED DATA ===========
+
+#INPUTSOURCES = [
+#    InputSource(id='sampledocs',label='Sample texts',path=ROOT+'/inputsources/sampledata',defaultmetadata=PlainTextFormat(None, encoding='utf-8') ),
+#]
+
+# ======== PROFILE DEFINITIONS ===========
+
+PROFILES = [
+    Profile(
+        InputTemplate('textinput', PlainTextFormat,"Input text document",
+            StaticParameter(id='encoding',name='Encoding',description='The character encoding of the file', value='utf-8'),
+            ChoiceParameter(id='language',name='Language',description='The language the text is in', choices=[('en','English'),('nl','Dutch'),('fr','French')]),
+            StringParameter(id='author',name='Author',description="The author's name", maxlength=100),
+            IntegerParameter(id='year',name='Year of Publication',description="The year of publication", minvalue=1900,maxvalue=2030),
+            CharEncodingConverter(id='latin1',label='Convert from Latin-1',charset='iso-8859-1'),
+            PDFtoTextConverter(id='pdfconv',label='Convert from PDF Document'),
+            MSWordConverter(id='docconv',label='Convert from MS Word Document'),
+            #InputSource(id='sampledoc', label="Sample Document", path=ROOT+'/inputsources/sampledoc.txt', metadata=PlainTextFormat(None, encoding='utf-8',language='en')),
+            extension='.txt',
+            multi=True,
+            acceptarchive=True,
+        ),
+        #------------------------------------------------------------------------------------------------------------------------
+        OutputTemplate('statsbydoc',PlainTextFormat,'Document Statistics',
+            SetMetaField('encoding','ascii'),
+            extension='.stats',
+            multi=True
+        ),
+        OutputTemplate('freqlistbydoc', PlainTextFormat,'Document Frequency list ',
+            CopyMetaField('language','textinput.language'),
+            CopyMetaField('encoding','textinput.encoding'),
+            SimpleTableViewer(),
+            extension='.freqlist',
+            multi=True
+        ),
+        OutputTemplate('overallstats', PlainTextFormat, 'Overall Statistics',
+            SetMetaField('encoding','ascii'),
+            ParameterCondition(author_set=True,
+                then=ParameterMetaField('author','author'),
+            ),
+            filename='overall.stats',
+            unique=True
+        ),
+        OutputTemplate('overallfreqlist', PlainTextFormat, 'Overall Frequency List',
+            SetMetaField('encoding','utf-8'),
+            ParameterCondition(author_set=True,
+                then=ParameterMetaField('author','author'),
+            ),
+            SimpleTableViewer(),
+            filename='overall.freqlist',
+            unique=True
+        ),
+        ParameterCondition(createlexicon=True,
+            then=OutputTemplate('lexicon', PlainTextFormat, 'Lexicon',
+                SetMetaField('encoding','utf-8'),
+                filename='overall.lexicon',
+                unique=True
+            )
+        )
+    )
+]
+
+# ======== COMMAND ===========
+
+#The system command. It is recommended you set this to small wrapper
+#script around your actual system. Full shell syntax is supported. Using
+#absolute paths is preferred. The current working directory will be
+#set to the project directory.
+#
+#You can make use of the following special variables,
+#which will be automatically set by CLAM:
+#     $INPUTDIRECTORY  - The directory where input files are uploaded.
+#     $OUTPUTDIRECTORY - The directory where the system should output
+#                        its output files.
+#     $STATUSFILE      - Filename of the .status file where the system
+#                        should output status messages.
+#     $DATAFILE        - Filename of the clam.xml file describing the
+#                        system and chosen configuration.
+#     $USERNAME        - The username of the currently logged in user
+#                        (set to "anonymous" if there is none)
+#     $PARAMETERS      - List of chosen parameters, using the specified flags
+#
+COMMAND = WRAPPERDIR + "/textstats.py $DATAFILE $STATUSFILE $OUTPUTDIRECTORY"
+
+# ======== PARAMETER DEFINITIONS ===========
+
+#The parameters are subdivided into several groups. In the form of a list of (groupname, parameters) tuples. The parameters are a list of instances from common/parameters.py
+PARAMETERS =  [
+    ('Main', [
+        BooleanParameter(id='createlexicon',name='Create Lexicon',description='Generate a separate overall lexicon?'),
+        ChoiceParameter(id='casesensitive',name='Case Sensitivity',description='Enable case sensitive behaviour?', choices=['yes','no'],default='no'),
+        IntegerParameter(id='freqlistlimit',name='Limit frequencylist',description='Limit entries in frequencylist to the top scoring ones. Value of zero (no limit) or higher',minvalue=0, maxvalue=99999999),
+        StringParameter(id='author',name='Author',description='Sign output metadata with the specified author name',maxlength=255),
+    ] )
+]

clam/tests/test.sh

@@ -46,14 +46,14 @@ fi
 echo "  ..ok" >&2
 
 echo "Running parameter tests:" >&2
-python parametertest.py 
+python parametertest.py
 if [ $? -ne 0 ]; then
    echo "ERROR: Parameter test failed!!" >&2
    GOOD=0
 fi
 
 echo "Running data tests:" >&2
-python datatest.py 
+python datatest.py
 if [ $? -ne 0 ]; then
    echo "ERROR: Data test failed!!" >&2
    GOOD=0
@@ -68,7 +68,7 @@ clamservice -d clam.config.textstats 2> servicetest.server.log &
 sleep 5
 
 echo "Running service tests:" >&2
-python servicetest.py 
+python servicetest.py
 if [ $? -ne 0 ]; then
     echo "ERROR: Service test failed!!" >&2
    GOOD=0
@@ -87,7 +87,7 @@ sleep 5
 
 
 echo "Running authentication tests:" >&2
-python authtest.py 
+python authtest.py
 if [ $? -ne 0 ]; then
    echo "ERROR: Authentication test failed!!" >&2
    GOOD=0
@@ -98,14 +98,29 @@ fi
 
 echo "Stopping clam service" >&2
 kill $(ps aux | grep 'clamservice' | awk '{print $2}') 2>/dev/null
-sleep 2 
+sleep 2
+
+echo "Starting clam service 'forwardauthtest'" >&2
+clamservice -d clam.config.forwardauthtest 2> forwardauthtest.server.log &
+sleep 5
+
+#simple curl test:
+curl -f -H "REMOTE_USER: test" http://mhysa:8080/
+if [ $? -ne 0 ]; then
+   echo "ERROR: Forwarded authentication failure" >&2
+fi
+
+
+echo "Stopping clam service" >&2
+kill $(ps aux | grep 'clamservice' | awk '{print $2}') 2>/dev/null
+sleep 2
 
 echo "Starting clam service 'actiontest'" >&2
 clamservice -d clam.config.actiontest 2> actiontest.server.log &
 sleep 5
 
 echo "Running actions tests:" >&2
-python actiontest.py 
+python actiontest.py
 if [ $? -ne 0 ]; then
    echo "ERROR: Action test failed!!" >&2
    GOOD=0
@@ -116,7 +131,7 @@ fi
 
 echo "Stopping clam service" >&2
 kill $(ps aux | grep 'clamservice' | awk '{print $2}') 2>/dev/null
-sleep 2 
+sleep 2
 
 if [ $GOOD -eq 1 ]; then
     echo "Done, all tests passed!" >&2

setup.py

@@ -12,7 +12,7 @@ def read(fname):
 
 setup(
     name = "CLAM",
-    version = "2.2", #also change in clam.common.data.VERSION
+    version = "2.2.1", #also change in clam.common.data.VERSION
     author = "Maarten van Gompel",
     author_email = "proycon@anaproy.nl",
     description = ("Turns command-line NLP tools into fully-fledged RESTful webservices with an auto-generated web-interface for human end-users."),