testDms.py 35 KB
Newer Older
1
# -*- coding: utf-8 -*-
Bartek Górny's avatar
Bartek Górny committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
##############################################################################
#
# Copyright (c) 2004 Nexedi SARL and Contributors. All Rights Reserved.
#          Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################

30 31 32
"""
  A test suite for Document Management System functionality.
  This will test:
Bartek Górny's avatar
Bartek Górny committed
33
  - creating Text Document objects
34 35 36 37 38 39 40 41 42 43 44 45 46
  - setting properties of a document, assigning local roles
  - setting relations between documents (explicit and implicity)
  - searching in basic and advanced modes
  - document publication workflow settings
  - sourcing external content
  - (...)
  This will NOT test:
  - contributing files of various types
  - convertion between many formats
  - metadata extraction and editing
  - email ingestion
  These are subject to another suite "testIngestion".
"""
Bartek Górny's avatar
Bartek Górny committed
47

48 49 50
# XXX test_02 works only with oood on
# XXX test_03 and test_04 work only WITHOUT oood (because of a known bug in erp5_dms)

51
import unittest
52
import time
Bartek Górny's avatar
Bartek Górny committed
53

54
import transaction
Bartek Górny's avatar
Bartek Górny committed
55 56
from Testing import ZopeTestCase
from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
57
from Products.ERP5Type.tests.utils import FileUpload
58
from Products.ERP5Type.tests.utils import DummyLocalizer
Jérome Perrin's avatar
Jérome Perrin committed
59
from AccessControl.SecurityManagement import newSecurityManager
Bartek Górny's avatar
Bartek Górny committed
60 61 62
from zLOG import LOG
import os

Bartek Górny's avatar
Bartek Górny committed
63
QUIET = 0
64
RUN_ALL_TEST = 1
Bartek Górny's avatar
Bartek Górny committed
65 66 67 68

# Define the conversion server host
conversion_server_host = ('127.0.0.1', 8008)

69
TEST_FILES_HOME = os.path.join(os.path.dirname(__file__), 'test_document')
70 71
FILE_NAME_REGULAR_EXPRESSION = "(?P<reference>[A-Z]{3,10})-(?P<language>[a-z]{2})-(?P<version>[0-9]{3})"
REFERENCE_REGULAR_EXPRESSION = "(?P<reference>[A-Z]{3,10})(-(?P<language>[a-z]{2}))?(-(?P<version>[0-9]{3}))?"
72

Bartek Górny's avatar
Bartek Górny committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86

def printAndLog(msg):
  """
  A utility function to print a message
  to the standard output and to the LOG
  at the same time
  """
  if not QUIET:
    msg = str(msg)
    ZopeTestCase._print('\n ' + msg)
    LOG('Testing... ', 0, msg)


def makeFilePath(name):
87
  return os.path.join(os.path.dirname(__file__), 'test_document', name)
Bartek Górny's avatar
Bartek Górny committed
88

89 90 91 92 93
def makeFileUpload(name, as_name=None):
  if as_name is None:
    as_name = name
  path = makeFilePath(name)
  return FileUpload(path, as_name)
Bartek Górny's avatar
Bartek Górny committed
94

95

96
class TestDocument(ERP5TypeTestCase, ZopeTestCase.Functional):
97 98 99
  """
    Test basic document - related operations
  """
Bartek Górny's avatar
Bartek Górny committed
100 101 102 103

  def getTitle(self):
    return "DMS"

104 105
  ## setup

106
  def afterSetUp(self):
107
    self.setSystemPreference()
108 109
    # set a dummy localizer (because normally it is cookie based)
    self.portal.Localizer = DummyLocalizer()
110 111 112 113
    # make sure every body can traverse document module
    self.portal.document_module.manage_permission('View', ['Anonymous'], 1)
    self.portal.document_module.manage_permission(
                           'Access contents information', ['Anonymous'], 1)
Bartek Górny's avatar
Bartek Górny committed
114

115 116 117 118 119 120
  def setSystemPreference(self):
    default_pref = self.portal.portal_preferences.default_site_preference
    default_pref.setPreferredOoodocServerAddress(conversion_server_host[0])
    default_pref.setPreferredOoodocServerPortNumber(conversion_server_host[1])
    default_pref.setPreferredDocumentFileNameRegularExpression(FILE_NAME_REGULAR_EXPRESSION)
    default_pref.setPreferredDocumentReferenceRegularExpression(REFERENCE_REGULAR_EXPRESSION)
121 122
    if default_pref.getPreferenceState() != 'global':
      default_pref.enable()
123

Bartek Górny's avatar
Bartek Górny committed
124 125 126 127
  def getDocumentModule(self):
    return getattr(self.getPortal(),'document_module')

  def getBusinessTemplateList(self):
128 129
    return ('erp5_base',
            'erp5_ingestion', 'erp5_ingestion_mysql_innodb_catalog',
130
            'erp5_web', 'erp5_dms')
Bartek Górny's avatar
Bartek Górny committed
131 132

  def getNeededCategoryList(self):
133
    return ()
Bartek Górny's avatar
Bartek Górny committed
134

135
  def beforeTearDown(self):
136 137 138 139 140
    """
      Do some stuff after each test:
      - clear document module
    """
    self.clearDocumentModule()
141

142
  def clearDocumentModule(self):
Bartek Górny's avatar
Bartek Górny committed
143
    """
144
      Remove everything after each run
Bartek Górny's avatar
Bartek Górny committed
145
    """
146
    transaction.abort()
147
    self.tic()
148 149 150
    doc_module = self.getDocumentModule()
    ids = [i for i in doc_module.objectIds()]
    doc_module.manage_delObjects(ids)
151
    transaction.commit()
152 153 154
    self.tic()

  ## helper methods
Bartek Górny's avatar
Bartek Górny committed
155

156
  def createTestDocument(self, file_name=None, portal_type='Text', reference='TEST', version='002', language='en'):
Bartek Górny's avatar
Bartek Górny committed
157 158 159
    """
      Creates a text document
    """
160
    dm=self.getPortal().document_module
161
    doctext=dm.newContent(portal_type=portal_type)
Bartek Górny's avatar
Bartek Górny committed
162
    if file_name is not None:
163
      f = open(makeFilePath(file_name), 'rb')
Bartek Górny's avatar
Bartek Górny committed
164 165 166 167 168
      doctext.setTextContent(f.read())
      f.close()
    doctext.setReference(reference)
    doctext.setVersion(version)
    doctext.setLanguage(language)
169
    return doctext
Bartek Górny's avatar
Bartek Górny committed
170

Bartek Górny's avatar
Bartek Górny committed
171 172 173 174 175 176 177 178
  def getDocument(self, id):
    """
      Returns a document with given ID in the
      document module.
    """
    document_module = self.portal.document_module
    return getattr(document_module, id)

179 180 181
  def clearCache(self):
    self.portal.portal_caches.clearAllCache()

Bartek Górny's avatar
Bartek Górny committed
182 183 184 185 186
  ## steps
  
  def stepTic(self, sequence=None, sequence_list=None, **kw):
    self.tic()

187 188
  ## tests

Bartek Górny's avatar
Bartek Górny committed
189 190 191 192
  def test_01_HasEverything(self, quiet=QUIET, run=RUN_ALL_TEST):
    """
      Standard test to make sure we have everything we need - all the tools etc
    """
193
    if not run: return
Bartek Górny's avatar
Bartek Górny committed
194
    printAndLog('\nTest Has Everything ')
195 196 197 198 199 200
    self.assertNotEqual(self.getCategoryTool(), None)
    self.assertNotEqual(self.getSimulationTool(), None)
    self.assertNotEqual(self.getTypeTool(), None)
    self.assertNotEqual(self.getSQLConnection(), None)
    self.assertNotEqual(self.getCatalogTool(), None)
    self.assertNotEqual(self.getWorkflowTool(), None)
201

202
  def test_02_RevisionSystem(self,quiet=QUIET,run=RUN_ALL_TEST):
Bartek Górny's avatar
Bartek Górny committed
203 204 205 206 207 208
    """
      Test revision mechanism
    """
    if not run: return
    printAndLog('\nTest Revision System')
    # create a test document
209
    # revision should be 1
Bartek Górny's avatar
Bartek Górny committed
210
    # upload file (can be the same) into it
211
    # revision should now be 2
212 213
    # edit the document with any value or no values
    # revision should now be 3
Bartek Górny's avatar
Bartek Górny committed
214
    # contribute the same file through portal_contributions
215 216
    # the same document should now have revision 4 (because it should have done mergeRevision)
    # getRevisionList should return (1, 2, 3, 4)
217 218 219 220
    filename = 'TEST-en-002.doc'
    file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=file)
    document.immediateReindexObject()
221
    transaction.commit()
222 223 224 225
    self.tic()
    document_url = document.getRelativeUrl()
    def getTestDocument():
      return self.portal.restrictedTraverse(document_url)
226
    self.assertEqual(getTestDocument().getRevision(), '1')
227
    getTestDocument().edit(file=file)
228
    transaction.commit()
229
    self.tic()
230
    self.assertEqual(getTestDocument().getRevision(), '2')
231
    getTestDocument().edit(title='Hey Joe')
232
    transaction.commit()
233
    self.tic()
234
    self.assertEqual(getTestDocument().getRevision(), '3')
235
    another_document = self.portal.portal_contributions.newContent(file=file)
236
    transaction.commit()
237
    self.tic()
238 239
    self.assertEqual(getTestDocument().getRevision(), '4')
    self.assertEqual(getTestDocument().getRevisionList(), ['1', '2', '3', '4'])
Bartek Górny's avatar
Bartek Górny committed
240 241 242 243 244 245 246

  def test_03_Versioning(self,quiet=QUIET,run=RUN_ALL_TEST):
    """
      Test versioning
    """
    if not run: return
    printAndLog('\nTest Versioning System')
247 248 249 250 251 252 253 254 255 256 257 258 259 260
    # create a document 1, set coordinates (reference=TEST, version=002, language=en)
    # create a document 2, set coordinates (reference=TEST, version=002, language=en)
    # create a document 3, set coordinates (reference=TEST, version=004, language=en)
    # run isVersionUnique on 1, 2, 3 (should return False, False, True)
    # change version of 2 to 003
    # run isVersionUnique on 1, 2, 3  (should return True)
    # run getLatestVersionValue on all (should return 3)
    # run getVersionValueList on 2 (should return [3, 2, 1])
    document_module = self.getDocumentModule()
    docs = {}
    docs[1] = self.createTestDocument(reference='TEST', version='002', language='en')
    docs[2] = self.createTestDocument(reference='TEST', version='002', language='en')
    docs[3] = self.createTestDocument(reference='TEST', version='004', language='en')
    docs[4] = self.createTestDocument(reference='ANOTHER', version='002', language='en')
261
    transaction.commit()
262 263 264 265 266
    self.tic()
    self.failIf(docs[1].isVersionUnique())
    self.failIf(docs[2].isVersionUnique())
    self.failUnless(docs[3].isVersionUnique())
    docs[2].setVersion('003')
267
    transaction.commit()
268 269 270 271 272 273 274 275 276
    self.tic()
    self.failUnless(docs[1].isVersionUnique())
    self.failUnless(docs[2].isVersionUnique())
    self.failUnless(docs[3].isVersionUnique())
    self.failUnless(docs[1].getLatestVersionValue() == docs[3])
    self.failUnless(docs[2].getLatestVersionValue() == docs[3])
    self.failUnless(docs[3].getLatestVersionValue() == docs[3])
    version_list = [br.getRelativeUrl() for br in docs[2].getVersionValueList()]
    self.failUnless(version_list == [docs[3].getRelativeUrl(), docs[2].getRelativeUrl(), docs[1].getRelativeUrl()])
Bartek Górny's avatar
Bartek Górny committed
277 278 279 280 281 282 283 284 285 286 287 288 289

  def test_04_VersioningWithLanguage(self,quiet=QUIET,run=RUN_ALL_TEST):
    """
      Test versioning with multi-language support
    """
    if not run: return
    printAndLog('\nTest Versioning With Language')
    # create empty test documents, set their coordinates as follows:
    # (1) TEST, 002, en
    # (2) TEST, 002, fr
    # (3) TEST, 002, pl
    # (4) TEST, 003, en
    # (5) TEST, 003, sp
290
    # the following calls (on any doc) should produce the following output:
Bartek Górny's avatar
Bartek Górny committed
291 292 293 294 295 296 297
    # getOriginalLanguage() = 'en'
    # getLanguageList = ('en', 'fr', 'pl', 'sp')
    # getLatestVersionValue() = 4
    # getLatestVersionValue('en') = 4
    # getLatestVersionValue('fr') = 2
    # getLatestVersionValue('pl') = 3
    # getLatestVersionValue('ru') = None
298
    # change user language into 'sp'
Bartek Górny's avatar
Bartek Górny committed
299
    # getLatestVersionValue() = 5
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    # add documents:
    # (6) TEST, 004, pl
    # (7) TEST, 004, en
    # getLatestVersionValue() = 7
    localizer = self.portal.Localizer
    document_module = self.getDocumentModule()
    docs = {}
    docs[1] = self.createTestDocument(reference='TEST', version='002', language='en')
    time.sleep(1) # time span here because catalog records only full seconds
    docs[2] = self.createTestDocument(reference='TEST', version='002', language='fr')
    time.sleep(1)
    docs[3] = self.createTestDocument(reference='TEST', version='002', language='pl')
    time.sleep(1)
    docs[4] = self.createTestDocument(reference='TEST', version='003', language='en')
    time.sleep(1)
    docs[5] = self.createTestDocument(reference='TEST', version='003', language='sp')
    time.sleep(1)
317
    transaction.commit()
318 319 320 321 322 323 324 325 326 327 328 329 330
    self.tic()
    doc = docs[2] # can be any
    self.failUnless(doc.getOriginalLanguage() == 'en')
    self.failUnless(doc.getLanguageList() == ['en', 'fr', 'pl', 'sp'])
    self.failUnless(doc.getLatestVersionValue() == docs[4]) # there are two latest - it chooses the one in user language
    self.failUnless(doc.getLatestVersionValue('en') == docs[4])
    self.failUnless(doc.getLatestVersionValue('fr') == docs[2])
    self.failUnless(doc.getLatestVersionValue('pl') == docs[3])
    self.failUnless(doc.getLatestVersionValue('ru') == None)
    localizer.changeLanguage('sp') # change user language
    self.failUnless(doc.getLatestVersionValue() == docs[5]) # there are two latest - it chooses the one in user language
    docs[6] = document_module.newContent(reference='TEST', version='004', language='pl')
    docs[7] = document_module.newContent(reference='TEST', version='004', language='en')
331
    transaction.commit()
332 333
    self.tic()
    self.failUnless(doc.getLatestVersionValue() == docs[7]) # there are two latest, neither in user language - it chooses the one in original language
Bartek Górny's avatar
Bartek Górny committed
334

335
  def test_06_testExplicitRelations(self,quiet=QUIET,run=RUN_ALL_TEST):
Bartek Górny's avatar
Bartek Górny committed
336 337 338 339 340 341
    """
      Test explicit relations.
      Explicit relations are just like any other relation, so no need to test them here
      except for similarity cloud which we test.
    """
    if not run: return
342
    
Bartek Górny's avatar
Bartek Górny committed
343 344 345 346 347 348 349 350
    printAndLog('\nTest Explicit Relations')
    # create test documents:
    # (1) TEST, 002, en
    # (2) TEST, 003, en
    # (3) ONE, 001, en
    # (4) TWO, 001, en
    # (5) THREE, 001, en
    # set 3 similar to 1, 4 to 3, 5 to 4
Romain Courteaud's avatar
Romain Courteaud committed
351
    # getSimilarCloudValueList on 4 should return 1, 3 and 5
Bartek Górny's avatar
Bartek Górny committed
352
    # getSimilarCloudValueList(depth=1) on 4 should return 3 and 5
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
    
    # create documents for test version and language
    # reference, version, language
    kw = {'portal_type': 'Drawing'}
    document1 = self.portal.document_module.newContent(**kw)
    document2 = self.portal.document_module.newContent(**kw)
    document3 = self.portal.document_module.newContent(**kw)
    document4 = self.portal.document_module.newContent(**kw)
    document5 = self.portal.document_module.newContent(**kw)
    
    document6 = self.portal.document_module.newContent(reference='SIX', version='001', 
                                                                                    language='en',  **kw)
    document7 = self.portal.document_module.newContent(reference='SEVEN', version='001', 
                                                                                    language='en',  **kw)
    document8 = self.portal.document_module.newContent(reference='SEVEN', version='001', 
                                                                                    language='fr',  **kw)
    document9 = self.portal.document_module.newContent(reference='EIGHT', version='001', 
                                                                                    language='en',  **kw)
    document10 = self.portal.document_module.newContent(reference='EIGHT', version='002', 
                                                                                      language='en',  **kw)
    document11 = self.portal.document_module.newContent(reference='TEN', version='001', 
                                                                                      language='en',  **kw)
    document12 = self.portal.document_module.newContent(reference='TEN', version='001', 
                                                                                      language='fr',  **kw)
    document13 = self.portal.document_module.newContent(reference='TEN', version='002', 
                                                                                      language='en',  **kw)
Romain Courteaud's avatar
Romain Courteaud committed
379 380 381 382

    document3.setSimilarValue(document1)
    document4.setSimilarValue(document3)
    document5.setSimilarValue(document4)
383 384 385 386
    
    document6.setSimilarValueList([document8,  document13])
    document7.setSimilarValue([document9])
    document11.setSimilarValue(document7)
Romain Courteaud's avatar
Romain Courteaud committed
387

388
    transaction.commit()
Romain Courteaud's avatar
Romain Courteaud committed
389
    self.tic()
390 391 392
    
    #if user language is 'en'
    self.portal.Localizer.changeLanguage('en')
Romain Courteaud's avatar
Romain Courteaud committed
393

394
    # 4 is similar to 3 and 5, 3 similar to 1, last version are the same
Romain Courteaud's avatar
Romain Courteaud committed
395 396 397 398
    self.assertSameSet([document1, document3, document5],
                       document4.getSimilarCloudValueList())
    self.assertSameSet([document3, document5],
                       document4.getSimilarCloudValueList(depth=1))
Bartek Górny's avatar
Bartek Górny committed
399

400 401 402 403 404 405 406 407 408 409 410 411 412 413
    self.assertSameSet([document7, document13], 
                       document6.getSimilarCloudValueList())
    self.assertSameSet([document10, document13], 
                       document7.getSimilarCloudValueList())
    self.assertSameSet([document7, document13], 
                       document9.getSimilarCloudValueList())
    self.assertSameSet([], 
                       document10.getSimilarCloudValueList())
    # 11 similar to 7, last version of 7 (en) is 7, similar of 7 is 9, last version of 9 (en) is 10
    self.assertSameSet([document7, document10], 
                       document11.getSimilarCloudValueList())
    self.assertSameSet([document6, document7], 
                       document13.getSimilarCloudValueList())

414
    transaction.commit()
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    
    # if user language is 'fr', test that latest documents are prefferable returned in user_language (if available)
    self.portal.Localizer.changeLanguage('fr')
   
    self.assertSameSet([document8, document13], 
                       document6.getSimilarCloudValueList())
    self.assertSameSet([document6, document13], 
                       document8.getSimilarCloudValueList())
    self.assertSameSet([document8, document10], 
                       document11.getSimilarCloudValueList())
    self.assertSameSet([], 
                       document12.getSimilarCloudValueList())
    self.assertSameSet([document6, document8], 
                       document13.getSimilarCloudValueList())
    
430
    transaction.commit()
431 432 433 434 435 436
    
    # if user language is "bg"
    self.portal.Localizer.changeLanguage('bg')
    self.assertSameSet([document8, document13], 
                       document6.getSimilarCloudValueList())

437
  def test_07_testImplicitRelations(self,quiet=QUIET,run=RUN_ALL_TEST):
Bartek Górny's avatar
Bartek Górny committed
438 439 440 441 442
    """
      Test implicit (wiki-like) relations.
    """
    # XXX this test should be extended to check more elaborate language selection
    if not run: return
443 444 445 446

    def sqlresult_to_document_list(result):
      return [i.getObject() for i in result]

Bartek Górny's avatar
Bartek Górny committed
447 448 449
    printAndLog('\nTest Implicit Relations')
    # create docs to be referenced:
    # (1) TEST, 002, en
450 451 452 453
    filename = 'TEST-en-002.odt'
    file = makeFileUpload(filename)
    document1 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
454
    # (2) TEST, 002, fr
455 456
    as_name = 'TEST-fr-002.odt'
    file = makeFileUpload(filename, as_name)
457 458
    document2 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
459
    # (3) TEST, 003, en
460 461
    as_name = 'TEST-en-003.odt'
    file = makeFileUpload(filename, as_name)
462 463
    document3 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
464 465
    # create docs to contain references in text_content:
    # REF, 001, en; "I use reference to look up TEST"
466 467 468 469
    filename = 'REF-en-001.odt'
    file = makeFileUpload(filename)
    document4 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
470
    # REF, 002, en; "I use reference to look up TEST"
471 472 473 474
    filename = 'REF-en-002.odt'
    file = makeFileUpload(filename)
    document5 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
475
    # REFLANG, 001, en: "I use reference and language to look up TEST-fr"
476 477 478 479
    filename = 'REFLANG-en-001.odt'
    file = makeFileUpload(filename)
    document6 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
480
    # REFVER, 001, en: "I use reference and version to look up TEST-002"
481 482 483 484
    filename = 'REFVER-en-001.odt'
    file = makeFileUpload(filename)
    document7 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
485
    # REFVERLANG, 001, en: "I use reference, version and language to look up TEST-002-en"
486 487 488 489
    filename = 'REFVERLANG-en-001.odt'
    file = makeFileUpload(filename)
    document8 = self.portal.portal_contributions.newContent(file=file)

490
    transaction.commit()
491
    self.tic()
Bartek Górny's avatar
Bartek Górny committed
492
    printAndLog('\nTesting Implicit Predecessors')
493 494
    # the implicit predecessor will find documents by reference.
    # version and language are not used.
Bartek Górny's avatar
Bartek Górny committed
495
    # the implicit predecessors should be:
496 497 498 499 500 501 502 503 504

    # for (1): REF-002, REFLANG, REFVER, REFVERLANG
    # document1's reference is TEST. getImplicitPredecessorValueList will
    # return latest version of documents which contains string "TEST".
    self.assertSameSet(
      [document5, document6, document7, document8],
      sqlresult_to_document_list(document1.getImplicitPredecessorValueList()))

    # clear transactional variable cache
505
    transaction.commit()
506

Bartek Górny's avatar
Bartek Górny committed
507
    printAndLog('\nTesting Implicit Successors')
508 509 510 511 512 513 514 515 516 517 518
    # the implicit successors should be return document with appropriate
    # language.

    # if user language is 'en'.
    self.portal.Localizer.changeLanguage('en')

    self.assertSameSet(
      [document3],
      sqlresult_to_document_list(document5.getImplicitSuccessorValueList()))

    # clear transactional variable cache
519
    transaction.commit()
520 521 522 523 524 525 526 527

    # if user language is 'fr'.
    self.portal.Localizer.changeLanguage('fr')
    self.assertSameSet(
      [document2],
      sqlresult_to_document_list(document5.getImplicitSuccessorValueList()))

    # clear transactional variable cache
528
    transaction.commit()
529 530 531 532 533 534

    # if user language is 'ja'.
    self.portal.Localizer.changeLanguage('ja')
    self.assertSameSet(
      [document3],
      sqlresult_to_document_list(document5.getImplicitSuccessorValueList()))
Bartek Górny's avatar
Bartek Górny committed
535

536 537 538 539 540 541 542 543 544 545 546 547 548 549
  def testOOoDocument_get_size(self):
    # test get_size on OOoDocument
    doc = self.portal.document_module.newContent(portal_type='Spreadsheet')
    doc.edit(file=makeFileUpload('import_data_list.ods'))
    self.assertEquals(len(makeFileUpload('import_data_list.ods').read()),
                      doc.get_size())

  def testTempOOoDocument_get_size(self):
    # test get_size on temporary OOoDocument
    from Products.ERP5Type.Document import newTempOOoDocument
    doc = newTempOOoDocument(self.portal, 'tmp')
    doc.edit(base_data='OOo')
    self.assertEquals(len('OOo'), doc.get_size())

550 551 552 553 554 555 556 557 558 559 560 561 562 563
  def testOOoDocument_hasData(self):
    # test hasData on OOoDocument
    doc = self.portal.document_module.newContent(portal_type='Spreadsheet')
    self.failIf(doc.hasData())
    doc.edit(file=makeFileUpload('import_data_list.ods'))
    self.failUnless(doc.hasData())

  def testTempOOoDocument_hasData(self):
    # test hasData on TempOOoDocument
    from Products.ERP5Type.Document import newTempOOoDocument
    doc = newTempOOoDocument(self.portal, 'tmp')
    self.failIf(doc.hasData())
    doc.edit(file=makeFileUpload('import_data_list.ods'))
    self.failUnless(doc.hasData())
564

565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
  def test_Owner_Base_download(self):
    # tests that owners can download OOo documents, and all headers (including
    # filenames) are set correctly
    doc = self.portal.document_module.newContent(
                                  source_reference='test.ods',
                                  portal_type='Spreadsheet')
    doc.edit(file=makeFileUpload('import_data_list.ods'))

    uf = self.portal.acl_users
    uf._doAddUser('member_user1', 'secret', ['Member', 'Owner'], [])
    user = uf.getUserById('member_user1').__of__(uf)
    newSecurityManager(None, user)

    response = self.publish('%s/Base_download' % doc.getPath(),
                            basic='member_user1:secret')
    self.assertEquals(makeFileUpload('import_data_list.ods').read(),
                      response.body)
    self.assertEquals('application/vnd.oasis.opendocument.spreadsheet',
                      response.headers['content-type'])
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
584
    self.assertEquals('attachment; filename="import_data_list.ods"',
585 586 587 588 589 590 591 592 593 594
                      response.headers['content-disposition'])

  def test_Member_download_pdf_format(self):
    # tests that members can download OOo documents in pdf format (at least in
    # published state), and all headers (including filenames) are set correctly
    doc = self.portal.document_module.newContent(
                                  source_reference='test.ods',
                                  portal_type='Spreadsheet')
    doc.edit(file=makeFileUpload('import_data_list.ods'))
    doc.publish()
595
    transaction.commit()
596
    self.tic()
597
    transaction.commit()
598 599 600 601 602 603 604 605 606

    uf = self.portal.acl_users
    uf._doAddUser('member_user2', 'secret', ['Member'], [])
    user = uf.getUserById('member_user2').__of__(uf)
    newSecurityManager(None, user)

    response = self.publish('%s/Document_convert?format=pdf' % doc.getPath(),
                            basic='member_user2:secret')
    self.assertEquals('application/pdf', response.headers['content-type'])
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
607
    self.assertEquals('attachment; filename="import_data_list.pdf"',
608 609
                      response.headers['content-disposition'])

610 611 612 613 614 615 616
    # test Print icon works on OOoDocument
    response = self.publish('%s/OOoDocument_print' % doc.getPath())
    self.assertEquals('application/pdf',
                      response.headers['content-type'])
    self.assertEquals('attachment; filename="import_data_list.pdf"',
                      response.headers['content-disposition'])

617
  def test_05_getCreationDate(self):
618 619 620 621 622 623 624 625 626 627 628 629 630
    """
    Check getCreationDate on all document type, as those documents 
    are not associated to edit_workflow.
    """
    portal = self.getPortalObject()
    for document_type in portal.getPortalDocumentTypeList():
      module = portal.getDefaultModule(document_type)
      obj = module.newContent(portal_type=document_type)
      self.assertNotEquals(obj.getCreationDate(),
                           module.getCreationDate())
      self.assertNotEquals(obj.getCreationDate(),
                           portal.CreationDate())

631 632
  def test_Base_getConversionFormatItemList(self):
    # tests Base_getConversionFormatItemList script (requires oood)
633
    self.assertTrue(('Microsoft Excel 97/2000/XP', 'xls') in
634 635 636 637 638
        self.portal.Base_getConversionFormatItemList(base_content_type=
                  'application/vnd.oasis.opendocument.spreadsheet'))
    self.assertTrue(('DocBook', 'docbook.xml') in
        self.portal.Base_getConversionFormatItemList(base_content_type=
                  'application/vnd.oasis.opendocument.text'))
639

640 641 642 643 644 645 646 647 648 649 650 651
  def test_06_ProcessingStateOfAClonedDocument(self,quiet=QUIET,run=RUN_ALL_TEST):
    """
    Check that the processing state of a cloned document
    is not draft
    """
    if not run: return
    printAndLog('\nProcessing State of a Cloned Document')
    filename = 'TEST-en-002.doc'
    file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=file)

    self.assertEquals('converting', document.getExternalProcessingState())
652
    transaction.commit()
653
    self.assertEquals('converting', document.getExternalProcessingState())
654 655 656 657 658 659 660 661

    # Clone a uploaded document
    container = document.getParentValue()
    clipboard = container.manage_copyObjects(ids=[document.getId()])
    paste_result = container.manage_pasteObjects(cb_copy_data=clipboard)
    new_document = container[paste_result[0]['new_id']]

    self.assertEquals('converting', new_document.getExternalProcessingState())
662
    transaction.commit()
663 664 665
    self.assertEquals('converting', new_document.getExternalProcessingState())

    # Change workflow state to converted
666 667
    self.tic()
    self.assertEquals('converted', document.getExternalProcessingState())
668
    self.assertEquals('converted', new_document.getExternalProcessingState())
669

670
    # Clone a converted document
671 672 673 674 675
    container = document.getParentValue()
    clipboard = container.manage_copyObjects(ids=[document.getId()])
    paste_result = container.manage_pasteObjects(cb_copy_data=clipboard)
    new_document = container[paste_result[0]['new_id']]

676
    self.assertEquals('converted', new_document.getExternalProcessingState())
677
    transaction.commit()
678
    self.assertEquals('converted', new_document.getExternalProcessingState())
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
    self.tic()
    self.assertEquals('converted', new_document.getExternalProcessingState())

  def test_07_EmbeddedDocumentOfAClonedDocument(self,quiet=QUIET,run=RUN_ALL_TEST):
    """
    Check the validation state of embedded document when its container is
    cloned
    """
    if not run: return
    printAndLog('\nValidation State of a Cloned Document')
    filename = 'TEST-en-002.doc'
    file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=file)

    sub_document = document.newContent(portal_type='Image')
    self.assertEquals('embedded', sub_document.getValidationState())
695
    transaction.commit()
696 697 698 699 700 701 702 703 704 705 706 707 708 709
    self.tic()
    self.assertEquals('embedded', sub_document.getValidationState())

    # Clone document
    container = document.getParentValue()
    clipboard = container.manage_copyObjects(ids=[document.getId()])

    paste_result = container.manage_pasteObjects(cb_copy_data=clipboard)
    new_document = container[paste_result[0]['new_id']]

    new_sub_document_list = new_document.contentValues(portal_type='Image')
    self.assertEquals(1, len(new_sub_document_list))
    new_sub_document = new_sub_document_list[0]
    self.assertEquals('embedded', new_sub_document.getValidationState())
710
    transaction.commit()
711 712 713
    self.tic()
    self.assertEquals('embedded', new_sub_document.getValidationState())

714 715 716 717 718 719 720 721 722 723
  def test_08_EmbeddedDocumentState(self,quiet=QUIET,run=RUN_ALL_TEST):
    """
    Check the validation state of an embedded document
    """
    if not run: return
    printAndLog('\nValidation State of an Embedded Document')
    filename = 'EmbeddedImage-en-002.odt'
    file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=file)

724
    transaction.commit()
725 726 727 728 729
    self.tic()

    self.assertEquals(0, len(document.contentValues(portal_type='Image')))
    document.convert(format='html')
    image_list = document.contentValues(portal_type='Image')
730 731 732
    self.assertEquals(0, len(image_list))
#     image = image_list[0]
#     self.assertEquals('embedded', image.getValidationState())
733

734 735 736 737 738 739 740 741 742 743 744 745
  def test_09_ScriptableKeys(self, quiet=QUIET, run=RUN_ALL_TEST):
    """
    Check the default DMS scriptale keys
    """
    if not run: return
    printAndLog('\nScriptable Keys')
    # Check that SQL generated is valid
    self.portal.portal_catalog(advanced_search_text='')
    self.portal.portal_catalog(advanced_search_text='a search text')
    self.portal.portal_catalog(portal_search_text='')
    self.portal.portal_catalog(portal_search_text='a search text')

746 747 748 749 750 751
    # Create a document.
    document_1 = self.portal.document_module.newContent(portal_type='File')
    document_1.setDescription('Hello. ScriptableKey is very useful if you want to make your own search syntax.')
    document_2 = self.portal.document_module.newContent(portal_type='File')
    document_2.setDescription('This test make sure that scriptable key feature on ZSQLCatalog works.')

752
    transaction.commit()
753 754 755 756 757 758 759
    self.tic()

    # Use scriptable key to search above documents.
    self.assertEqual(len(self.portal.portal_catalog(advanced_search_text='ScriptableKey')), 1)
    self.assertEqual(len(self.portal.portal_catalog(advanced_search_text='RelatedKey')), 0)
    self.assertEqual(len(self.portal.portal_catalog(advanced_search_text='make')), 2)

760 761 762 763 764 765 766
  def test_PDFTextContent(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
    document = self.portal.portal_contributions.newContent(file=upload_file)
    self.assertEquals('PDF', document.getPortalType())
    self.assertEquals('I use reference to look up TEST\n',
                      document._convertToText())
    self.assert_('I use reference to look up TEST' in
767
                 document._convertToHTML().replace('&nbsp;', ' '))
768 769 770
    self.assert_('I use reference to look up TEST' in
                 document.SearchableText())

771 772 773 774 775 776 777 778 779 780
  def test_PDFToImage(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
    document = self.portal.portal_contributions.newContent(file=upload_file)
    self.assertEquals('PDF', document.getPortalType())
    content_type, image_data = document.convert(format='png',
                                           frame=0,
                                           display='thumbnail')
    # it's a valid PNG
    self.assertEquals('PNG', image_data[1:4])
    
781 782 783 784 785 786 787 788
  def test_PDF_content_information(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
    document = self.portal.portal_contributions.newContent(file=upload_file)
    self.assertEquals('PDF', document.getPortalType())
    content_information = document.getContentInformation()
    self.assertEquals('1', content_information['Pages'])
    self.assertEquals('subject', content_information['Subject'])
    self.assertEquals('title', content_information['Title'])
789
    self.assertEquals('application/pdf', document.getContentType())
790

791 792
  def test_PDF_content_content_type(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
793 794 795 796 797 798 799 800 801 802
    document = self.portal.document_module.newContent(portal_type='PDF')
    # Here we use edit instead of setFile,
    # because only edit method set filename as source_reference.
    # This is a feature related to portal_contribution,
    # sometimes filename is replaced by value provided by
    # rewriteIngestionData type based method.
    # setFile should keep value provided by portal_contribution
    # instead of reading it from file itself.
    # See special parameter set_filename__ in EPR5.Tool.ContributionTool
    document.edit(file=upload_file)
803
    self.assertEquals('application/pdf', document.getContentType())
804

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
class TestDocumentWithSecurity(ERP5TypeTestCase):

  username = 'yusei'

  def getTitle(self):
    return "DMS with security"

  def afterSetUp(self):
    self.setSystemPreference()
    # set a dummy localizer (because normally it is cookie based)
    self.portal.Localizer = DummyLocalizer()
    # make sure every body can traverse document module
    self.portal.document_module.manage_permission('View', ['Anonymous'], 1)
    self.portal.document_module.manage_permission(
                           'Access contents information', ['Anonymous'], 1)
    self.login()

  def setSystemPreference(self):
    default_pref = self.portal.portal_preferences.default_site_preference
    default_pref.setPreferredOoodocServerAddress(conversion_server_host[0])
    default_pref.setPreferredOoodocServerPortNumber(conversion_server_host[1])
    default_pref.setPreferredDocumentFileNameRegularExpression(FILE_NAME_REGULAR_EXPRESSION)
    default_pref.setPreferredDocumentReferenceRegularExpression(REFERENCE_REGULAR_EXPRESSION)
828 829
    if default_pref.getPreferenceState() != 'global':
      default_pref.enable()
830
    transaction.commit()
831 832 833 834 835 836 837 838 839 840 841 842
    self.tic()

  def login(self):
    uf = self.getPortal().acl_users
    uf._doAddUser(self.username, '', ['Auditor', 'Author'], [])
    user = uf.getUserById(self.username).__of__(uf)
    newSecurityManager(None, user)

  def getDocumentModule(self):
    return getattr(self.getPortal(),'document_module')

  def getBusinessTemplateList(self):
843 844
    return ('erp5_base',
            'erp5_ingestion', 'erp5_ingestion_mysql_innodb_catalog',
845
            'erp5_web', 'erp5_dms')
846 847 848 849 850 851 852 853 854 855

  def test_ShowPreviewAfterSubmitted(self, quiet=QUIET, run=RUN_ALL_TEST):
    """
    Make sure that uploader can preview document after submitted.
    """
    if not run: return
    filename = 'REF-en-001.odt'
    upload_file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=upload_file)

856
    transaction.commit()
857 858 859 860 861 862
    self.tic()

    document.submit()

    preview_html = document.Document_getPreviewAsHTML().replace('\n', ' ')

863
    transaction.commit()
864 865 866 867 868
    self.tic()

    self.assert_('I use reference to look up TEST' in preview_html)


869 870 871
def test_suite():
  suite = unittest.TestSuite()
  suite.addTest(unittest.makeSuite(TestDocument))
872
  suite.addTest(unittest.makeSuite(TestDocumentWithSecurity))
873
  return suite
Bartek Górny's avatar
Bartek Górny committed
874 875 876


# vim: syntax=python shiftwidth=2