Project

General

Profile

1
/**
2
 *  '$RCSfile$'
3
 *  Copyright: 2010 Regents of the University of California and the
4
 *              National Center for Ecological Analysis and Synthesis
5
 *  Purpose: To test the Access Controls in metacat by JUnit
6
 *
7
 *   '$Author: leinfelder $'
8
 *     '$Date: 2012-01-11 11:31:11 -0800 (Wed, 11 Jan 2012) $'
9
 * '$Revision: 6882 $'
10
 *
11
 * This program is free software; you can redistribute it and/or modify
12
 * it under the terms of the GNU General Public License as published by
13
 * the Free Software Foundation; either version 2 of the License, or
14
 * (at your option) any later version.
15
 *
16
 * This program is distributed in the hope that it will be useful,
17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
 * GNU General Public License for more details.
20
 *
21
 * You should have received a copy of the GNU General Public License
22
 * along with this program; if not, write to the Free Software
23
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24
 */
25

    
26
package edu.ucsb.nceas.metacat.dataone;
27

    
28
import java.io.ByteArrayInputStream;
29
import java.io.InputStream;
30
import java.text.SimpleDateFormat;
31
import java.util.Calendar;
32
import java.util.Date;
33
import java.util.List;
34

    
35
import junit.framework.Test;
36
import junit.framework.TestSuite;
37

    
38
import org.apache.commons.io.IOUtils;
39
import org.dataone.client.D1Client;
40
import org.dataone.service.exceptions.BaseException;
41
import org.dataone.service.exceptions.NotAuthorized;
42
import org.dataone.service.exceptions.NotFound;
43
import org.dataone.service.exceptions.NotImplemented;
44
import org.dataone.service.exceptions.ServiceFailure;
45
import org.dataone.service.types.v1.AccessPolicy;
46
import org.dataone.service.types.v1.AccessRule;
47
import org.dataone.service.types.v1.Checksum;
48
import org.dataone.service.types.v1.Event;
49
import org.dataone.service.types.v1.Identifier;
50
import org.dataone.service.types.v1.Log;
51
import org.dataone.service.types.v1.Node;
52
import org.dataone.service.types.v1.NodeList;
53
import org.dataone.service.types.v1.NodeReference;
54
import org.dataone.service.types.v1.NodeType;
55
import org.dataone.service.types.v1.ObjectFormat;
56
import org.dataone.service.types.v1.ObjectFormatIdentifier;
57
import org.dataone.service.types.v1.ObjectFormatList;
58
import org.dataone.service.types.v1.ObjectInfo;
59
import org.dataone.service.types.v1.ObjectList;
60
import org.dataone.service.types.v1.Permission;
61
import org.dataone.service.types.v1.Replica;
62
import org.dataone.service.types.v1.ReplicationPolicy;
63
import org.dataone.service.types.v1.ReplicationStatus;
64
import org.dataone.service.types.v1.Session;
65
import org.dataone.service.types.v1.Subject;
66
import org.dataone.service.types.v1.SystemMetadata;
67
import org.dataone.service.util.Constants;
68

    
69
/**
70
 * A JUnit test for testing the dataone CNCore implementation
71
 */
72
public class CNodeServiceTest extends D1NodeServiceTest {   
73
    
74
    /**
75
    * constructor for the test
76
    */
77
    public CNodeServiceTest(String name)
78
    {
79
        super(name);
80
    }
81

    
82
	/**
83
	 * Create a suite of tests to be run together
84
	 */
85
	public static Test suite() 
86
	{
87
		TestSuite suite = new TestSuite();
88
		suite.addTest(new CNodeServiceTest("initialize"));
89
		
90
		suite.addTest(new CNodeServiceTest("testChecksum"));
91
		suite.addTest(new CNodeServiceTest("testCreate"));
92
		suite.addTest(new CNodeServiceTest("testGet"));
93
		suite.addTest(new CNodeServiceTest("testGetFormat"));
94
		suite.addTest(new CNodeServiceTest("testGetLogRecords"));
95
		suite.addTest(new CNodeServiceTest("testGetSystemMetadata"));
96
		suite.addTest(new CNodeServiceTest("testIsAuthorized"));
97
		suite.addTest(new CNodeServiceTest("testListFormats"));
98
		suite.addTest(new CNodeServiceTest("testListNodes"));
99
		suite.addTest(new CNodeServiceTest("testObjectFormatNotFoundException"));
100
		suite.addTest(new CNodeServiceTest("testRegisterSystemMetadata"));
101
		suite.addTest(new CNodeServiceTest("testReplicationPolicy"));
102
		suite.addTest(new CNodeServiceTest("testReplicationStatus"));
103
		suite.addTest(new CNodeServiceTest("testReserveIdentifier"));
104
		suite.addTest(new CNodeServiceTest("testSearch"));
105
		suite.addTest(new CNodeServiceTest("testSetAccessPolicy"));
106
		suite.addTest(new CNodeServiceTest("testSetOwner"));
107
	
108
		return suite;
109
	}
110
	
111
	
112
	/**
113
	 * test for registering standalone system metadata
114
	 */
115
	public Identifier testRegisterSystemMetadata() {
116
	    printTestHeader("testRegisterSystemMetadata");
117

    
118
	    try {
119
            Session session = getTestSession();
120
			Identifier guid = new Identifier();
121
			guid.setValue("testRegisterSystemMetadata." + System.currentTimeMillis());
122
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
123
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
124
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
125
			assertEquals(guid.getValue(), retGuid.getValue());
126
			return retGuid;
127
        } catch(Exception e) {
128
            fail("Unexpected error: " + e.getMessage());
129
        }
130
        return null;
131
	}
132
	
133
	/**
134
	 * test for getting system metadata
135
	 */
136
	public void testGetSystemMetadata() {
137
	    printTestHeader("testGetSystemMetadata");
138

    
139
	    try {
140
            Session session = getTestSession();
141
			Identifier guid = new Identifier();
142
			guid.setValue("testGetSystemMetadata." + System.currentTimeMillis());
143
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
144
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
145
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
146
			assertEquals(guid.getValue(), retGuid.getValue());
147
			// get it
148
			SystemMetadata retSysmeta = CNodeService.getInstance(request).getSystemMetadata(session, guid);
149
			// check it
150
			assertEquals(sysmeta.getIdentifier().getValue(), retSysmeta.getIdentifier().getValue());
151
        } catch(Exception e) {
152
            fail("Unexpected error: " + e.getMessage());
153
        }
154
	}
155
	
156
	public void testGetLogRecords() {
157
	    printTestHeader("testGetLogRecords");
158
	    try {
159

    
160
		    Session session = getTestSession();
161
		    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
162
		    Date fromDate = sdf.parse("2010-01-01");
163
		    Date toDate = new Date();
164
		    Event event = Event.CREATE;
165
		    int start = 0;
166
		    int count = 1;
167
	    
168
		    Log log = CNodeService.getInstance(request).getLogRecords(session, fromDate, toDate, 
169
		    	event, start, count);
170
		    assertNotNull(log);
171
		    assertTrue(log.getCount() == count);
172
		    assertTrue(log.getStart() == start);
173
		    assertTrue(log.getTotal() > 0);
174
	    } catch (Exception e) {
175
		    e.printStackTrace();
176
		    fail("Unexpected error: " + e.getMessage());
177
	    } 
178
	}
179
	
180
	public void testCreate() {
181
	    printTestHeader("testCreate");
182

    
183
	    try {
184
            Session session = getTestSession();
185
			Identifier guid = new Identifier();
186
			guid.setValue("testCreate." + System.currentTimeMillis());
187
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
188
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
189
			Identifier pid = CNodeService.getInstance(request).create(session, guid, object, sysmeta);
190
			assertEquals(guid, pid);
191
        } catch(Exception e) {
192
        	e.printStackTrace();
193
            fail("Unexpected error: " + e.getMessage());
194
        }
195
	}
196
	
197
	public void testGet() {
198
	    printTestHeader("testGet");
199

    
200
	    try {
201
            Session session = getTestSession();
202
			Identifier guid = new Identifier();
203
			guid.setValue("testGet." + System.currentTimeMillis());
204
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
205
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
206
			Identifier pid = CNodeService.getInstance(request).create(session, guid, object, sysmeta);
207
			assertEquals(guid.getValue(), pid.getValue());
208
			// get it
209
			InputStream retObject = CNodeService.getInstance(request).get(session, pid);
210
			// check it
211
			object.reset();
212
			assertTrue(IOUtils.contentEquals(object, retObject));
213
        } catch(Exception e) {
214
        	e.printStackTrace();
215
            fail("Unexpected error: " + e.getMessage());
216
        }
217
	}
218
	
219
	public void testChecksum() {
220
	    printTestHeader("testChecksum");
221

    
222
	    try {
223
            Session session = getTestSession();
224
			Identifier guid = new Identifier();
225
			guid.setValue("testChecksum." + System.currentTimeMillis());
226
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
227
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
228
			// save it
229
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
230
			assertEquals(guid.getValue(), retGuid.getValue());
231
			// check it
232
			Checksum checksum = CNodeService.getInstance(request).getChecksum(session, guid);
233
			assertEquals(sysmeta.getChecksum().getValue(), checksum.getValue());
234
        } catch(Exception e) {
235
            fail("Unexpected error: " + e.getMessage());
236
        }
237
	}
238
	
239
	public void testListNodes() {
240
	    printTestHeader("testListNodes");
241

    
242
	    try {
243
	    	CNodeService.getInstance(request).listNodes();
244
        } catch(NotImplemented e) {
245
        	// expecting not implemented
246
            assertTrue(true);
247
        } catch(Exception e) {
248
            fail("Unexpected error: " + e.getMessage());
249
        }
250
	}
251
	
252
	public void testReserveIdentifier() {
253
	    printTestHeader("testReserveIdentifier");
254

    
255
	    try {
256
            Session session = getTestSession();
257
			Identifier guid = new Identifier();
258
			guid.setValue("testReserveIdentifier." + System.currentTimeMillis());
259
			// reserve it
260
			Identifier resultPid = CNodeService.getInstance(request).reserveIdentifier(session, guid);
261
			assertNotNull(resultPid);
262
			assertEquals(guid.getValue(), resultPid.getValue());
263
	    } catch(NotImplemented ni) {
264
        	// this is not implemented in Metacat
265
            assertTrue(true);	
266
        } catch(Exception e) {
267
        	e.printStackTrace();
268
            fail("Unexpected error: " + e.getMessage());
269
        }
270
	}
271
	
272
	public void testSearch() {
273
	    printTestHeader("testSearch");
274

    
275
	    try {
276
            Session session = getTestSession();
277
			Identifier guid = new Identifier();
278
			guid.setValue("testSearch." + System.currentTimeMillis());
279
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
280
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
281
			
282
			// save it
283
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
284
			assertEquals(guid.getValue(), retGuid.getValue());
285
			// search for it
286
			ObjectList objectList = CNodeService.getInstance(request).search(session, null, null);
287
			// check it
288
			assertNotNull(objectList);
289
			boolean result = false;
290
			for (ObjectInfo objectInfo: objectList.getObjectInfoList()) {
291
				Identifier pid = objectInfo.getIdentifier();
292
				if (pid.getValue().equals(guid.getValue())) {
293
					result = true;
294
					break;
295
				}
296
			}
297
			assertTrue(result);
298
        } catch(Exception e) {
299
            fail("Unexpected error: " + e.getMessage());
300
        }
301
	}
302
	
303
	public void testSetOwner() {
304
	    printTestHeader("testSetOwner");
305

    
306
	    try {
307
            Session session = getTestSession();
308
			Identifier guid = new Identifier();
309
			guid.setValue("testSetOwner." + System.currentTimeMillis());
310
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
311
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
312
			long serialVersion = 1L;
313
			// save it
314
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
315
			assertEquals(guid.getValue(), retGuid.getValue());
316
			Subject rightsHolder = new Subject();
317
			rightsHolder.setValue("newUser");
318
			// set it
319
			Identifier retPid = CNodeService.getInstance(request).setRightsHolder(session, guid, rightsHolder, serialVersion);
320
			assertEquals(guid, retPid);
321
			// get it
322
			sysmeta = CNodeService.getInstance(request).getSystemMetadata(session, guid);
323
			assertNotNull(sysmeta);
324
			// check it
325
			assertTrue(rightsHolder.equals(sysmeta.getRightsHolder()));
326
			
327
        } catch(Exception e) {
328
            fail("Unexpected error: " + e.getMessage());
329
        }
330
	}
331
	
332
	public void testSetAccessPolicy() {
333
	    printTestHeader("testSetAccessPolicy");
334

    
335
	    try {
336
            Session session = getTestSession();
337
			Identifier guid = new Identifier();
338
			guid.setValue("testSetAccessPolicy." + System.currentTimeMillis());
339
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
340
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
341
	    long serialVersion = 1L;
342

    
343
			// save it
344
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
345
			assertEquals(guid.getValue(), retGuid.getValue());
346
			AccessPolicy accessPolicy = new AccessPolicy();
347
			AccessRule accessRule = new AccessRule();
348
			accessRule.addPermission(Permission.WRITE);
349
			Subject publicSubject = new Subject();
350
			publicSubject.setValue(Constants.SUBJECT_PUBLIC);
351
			accessRule.addSubject(publicSubject);
352
			accessPolicy.addAllow(accessRule);
353
			// set it
354
			boolean result = CNodeService.getInstance(request).setAccessPolicy(session, guid, accessPolicy, serialVersion );
355
			assertTrue(result);
356
			// check it
357
			result = CNodeService.getInstance(request).isAuthorized(session, guid, Permission.WRITE);
358
			assertTrue(result);
359
        } catch(Exception e) {
360
            fail("Unexpected error: " + e.getMessage());
361
        }
362
	}
363
	
364
	public void testIsAuthorized() {
365
	    printTestHeader("testIsAuthorized");
366

    
367
	    try {
368
            Session session = getTestSession();
369
			Identifier guid = new Identifier();
370
			guid.setValue("testIsAuthorized." + System.currentTimeMillis());
371
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
372
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
373
			// save it
374
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
375
			assertEquals(guid.getValue(), retGuid.getValue());
376
			// check it
377
			Subject publicSubject = new Subject();
378
			publicSubject.setValue(Constants.SUBJECT_PUBLIC);
379
			session.setSubject(publicSubject);
380
			// public read
381
			boolean result = CNodeService.getInstance(request).isAuthorized(session, guid, Permission.READ);
382
			assertTrue(result);
383
			// not public write
384
			try {
385
				result = false;
386
				result = CNodeService.getInstance(request).isAuthorized(session, guid, Permission.WRITE);
387
				fail("Public WRITE should be denied");
388
			} catch (NotAuthorized nae) {
389
				result = true;
390
			}
391
			assertTrue(result);
392
        } catch(Exception e) {
393
            fail("Unexpected error: " + e.getMessage());
394
        }
395
	}
396
	
397
	public void testReplicationPolicy() {
398
	    printTestHeader("testReplicationPolicy");
399

    
400
	    try {
401
            Session session = getTestSession();
402
			Identifier guid = new Identifier();
403
			guid.setValue("testReplicationPolicy." + System.currentTimeMillis());
404
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
405
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
406
	    long serialVersion = 1L;
407

    
408
			// save it
409
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
410
			assertEquals(guid.getValue(), retGuid.getValue());
411
			
412
			ReplicationPolicy policy = new ReplicationPolicy();
413
			NodeReference node = new NodeReference();
414
			node.setValue("testNode");
415
			policy.addPreferredMemberNode(node );
416
			// set it
417
			boolean result = CNodeService.getInstance(request).setReplicationPolicy(session, guid, policy, serialVersion);
418
			assertTrue(result);
419
			// get it
420
			sysmeta = CNodeService.getInstance(request).getSystemMetadata(session, guid);
421
			assertNotNull(sysmeta);
422
			// check it
423
			assertEquals(policy.getPreferredMemberNode(0).getValue(), sysmeta.getReplicationPolicy().getPreferredMemberNode(0).getValue());
424
			
425
        } catch(Exception e) {
426
            fail("Unexpected error: " + e.getMessage());
427
        }
428
	}
429
	
430
	public void testReplicationStatus() {
431
	    printTestHeader("testReplicationStatus");
432

    
433
	    try {
434
            Session session = getTestSession();
435
			Identifier guid = new Identifier();
436
			guid.setValue("testReplicationStatus." + System.currentTimeMillis());
437
			InputStream object = new ByteArrayInputStream("test".getBytes("UTF-8"));
438
			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);
439
			Replica replica = new Replica();
440
			NodeReference replicaMemberNode = new NodeReference();
441
			replicaMemberNode.setValue("testNode");
442
			replica.setReplicationStatus(ReplicationStatus.REQUESTED);
443
			replica.setReplicaMemberNode(replicaMemberNode);
444
			replica.setReplicaVerified(Calendar.getInstance().getTime());
445
			sysmeta.addReplica(replica );
446
			// save it
447
			Identifier retGuid = CNodeService.getInstance(request).registerSystemMetadata(session, guid, sysmeta);
448
			assertEquals(guid.getValue(), retGuid.getValue());
449
			// set it
450
			ReplicationStatus status = ReplicationStatus.COMPLETED;
451
			BaseException failure = new NotAuthorized("000", "Mock exception for " + this.getClass().getName());
452
			boolean result = CNodeService.getInstance(request).setReplicationStatus(session, guid, replicaMemberNode, status, failure);
453
			assertTrue(result);
454
			// get it
455
			sysmeta = CNodeService.getInstance(request).getSystemMetadata(session, guid);
456
			assertNotNull(sysmeta);
457
			// check it
458
			assertEquals(status, sysmeta.getReplica(0).getReplicationStatus());
459
			
460
        } catch(Exception e) {
461
            fail("Unexpected error: " + e.getMessage());
462
        }
463
	}
464
	
465
	/**
466
	 * Run an initial test that always passes to check that the test harness is
467
	 * working.
468
	 */
469
	public void initialize() 
470
	{
471
	    printTestHeader("initialize");
472
		assertTrue(1 == 1);
473
	}
474
	
475
	/**
476
	 * We want to act as the CN itself
477
	 * @throws ServiceFailure 
478
	 * @throws Exception 
479
	 */
480
	@Override
481
	public Session getTestSession() throws Exception {
482
		Session session = super.getTestSession();
483
		
484
		// use the first CN we find in the nodelist
485
        NodeList nodeList = D1Client.getCN().listNodes();
486
        for (Node node : nodeList.getNodeList()) {
487
            if ( node.getType().equals(NodeType.CN) ) {
488
                
489
                List<Subject> subjects = node.getSubjectList();
490
                for (Subject subject : subjects) {
491
                   session.setSubject(subject);
492
                   // we are done here
493
                   return session;
494
                }
495
            }
496
        }
497
        // in case we didn't find it
498
        return session;
499
	}
500
	
501

    
502
	/**
503
	 * test to list the object formats registered in metacat
504
	 */
505
	public void testListFormats() {
506
		
507
    printTestHeader("testListFormats");
508
    
509
    // make sure we are set up
510
    setUpFormats();
511
    
512
    // there should be at least 59 formats in the list
513
  	int formatsCount = 59;
514
  	ObjectFormatList objectFormatList;
515
  	
516
  	try {
517
	    objectFormatList = CNodeService.getInstance(request).listFormats();
518
	  	assertTrue(objectFormatList.getTotal() >= formatsCount);
519
  	
520
  	} catch (ServiceFailure e) {
521
  		fail("Could not get the object format list: " + e.getMessage());
522

    
523
    } catch (NotImplemented e) {
524
  		fail("Could not get the object format list: " + e.getMessage());
525

    
526
    }
527
    
528
	}
529
	
530
  /**
531
   * Test getting a single object format from the registered list
532
   */
533
  public void testGetFormat() {
534
  	
535
    printTestHeader("testGetFormat");
536

    
537
    // make sure we are set up
538
    setUpFormats();
539
    
540
    String knownFormat = "text/plain";
541
    ObjectFormatIdentifier fmtid = new ObjectFormatIdentifier();
542
    fmtid.setValue(knownFormat);
543
  	
544
    try {
545
	    
546
			String result = 
547
				CNodeService.getInstance(request).getFormat(fmtid).getFormatId().getValue();
548
	  	System.out.println("Expected result: " + knownFormat);
549
	  	System.out.println("Found    result: " + result);
550
	  	assertTrue(result.equals(knownFormat));
551
  
552
    } catch (NullPointerException npe) {	  
553
	    fail("The returned format was null: " + npe.getMessage());
554
    
555
    } catch (NotFound nfe) {     
556
    	fail("The format " + knownFormat + " was not found: " + nfe.getMessage());
557
    	
558
    } catch (ServiceFailure sfe) {
559
    	fail("The format " + knownFormat + " was not found: " + sfe.getMessage());
560

    
561
    } catch (NotImplemented nie) {
562
    	fail("The getFormat() method has not been implemented: " + nie.getMessage());
563

    
564
    }
565
  	
566
  }
567
	
568
  /**
569
   * Test getting a non-existent object format, returning NotFound
570
   */
571
  public void testObjectFormatNotFoundException() {
572
  
573
    printTestHeader("testObjectFormatNotFoundException");
574

    
575
    ObjectFormatIdentifier fmtid = new ObjectFormatIdentifier();
576
  	String badFormat = "text/bad-format";
577
  	fmtid.setValue(badFormat);
578
  	
579
  	try {
580
  		
581
	    ObjectFormat objectFormat = 
582
	    	CNodeService.getInstance(request).getFormat(fmtid);
583
      
584
  	} catch (Exception e) {
585
	    
586
  		assertTrue(e instanceof NotFound);
587
  	}
588
  	
589
  }
590
 
591
}
(1-1/4)