node-client-api/test-basic/documents-temporal-protect.js at MLE-30272 · marklogic/node-client-api · GitHub

1
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
* Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
*/
var should = require('should');
var fs = require('fs');
var testconfig = require('../etc/test-config.js');
var marklogic = require('../');
var db = marklogic.createDatabaseClient(testconfig.restTemporalConnection);

describe('temporal protect', function() {
  var DEFAULT_LEVEL = 'noDelete';
  var archiveFile = __dirname + '/temp.txt';
  var content = {
    property1:       'original',
    systemStartTime: '1111-11-11T11:11:11Z',
    systemEndTime:   '9999-12-31T23:59:59Z',
    validStartTime:  '1111-11-11T11:11:11Z',
    validEndTime:    '9999-12-31T23:59:59Z'
  };
  it('should protect a temporal document with duration and default level', function(done) {
    db.documents.write({
      documents: {
        uri: 'tempDoc1.json',
        content: content
      },
      temporalCollection: 'temporalCollection'
    }).result(function(response){
      return db.documents.protect({
        uri: 'tempDoc1.json',
        temporalCollection: 'temporalCollection',
        duration: 'PT0S'
      }).result();
    }).then(function(response) {
      response.uri.should.equal('tempDoc1.json');
      response.temporalCollection.should.equal('temporalCollection');
      response.level.should.equal(DEFAULT_LEVEL);
      return db.documents.read({
        uris: 'tempDoc1.json',
        categories: 'metadataValues'
      }).result();
    }).then(function(response){
      var m = response[0];
      m.should.have.property('metadataValues');
      m.metadataValues.should.have.property('temporalDocURI');
      m.metadataValues.temporalDocURI.should.equal('tempDoc1.json');
      m.metadataValues.should.have.property('temporalProtectLevel');
      m.metadataValues.temporalProtectLevel.should.equal(DEFAULT_LEVEL);
      m.metadataValues.should.have.property('temporalProtectExTime');
      return db.documents.wipe({
        uri: 'tempDoc1.json',
        temporalCollection: 'temporalCollection'
      }).result();
    }).then(function(response){
      done();
    }).catch(done);
  });
  it('should protect a temporal document with an expireTime and level', function(done) {
    db.documents.write({
      documents: {
        uri: 'tempDoc2.json',
        content: content
      },
      temporalCollection: 'temporalCollection'
    }).result(function(response){
      return db.documents.protect({
        uri: 'tempDoc2.json',
        temporalCollection: 'temporalCollection',
        expireTime: '2016-06-03T19:56:17.681154-07:00',
        level: 'noWipe'
      }).result();
    }).then(function(response) {
      response.uri.should.equal('tempDoc2.json');
      response.temporalCollection.should.equal('temporalCollection');
      response.level.should.equal('noWipe');
      return db.documents.read({
        uris: 'tempDoc2.json',
        categories: 'metadataValues'
      }).result();
    }).then(function(response){
      var m = response[0];
      m.should.have.property('metadataValues');
      m.metadataValues.should.have.property('temporalDocURI');
      m.metadataValues.temporalDocURI.should.equal('tempDoc2.json');
      m.metadataValues.should.have.property('temporalProtectLevel');
      m.metadataValues.temporalProtectLevel.should.equal('noWipe');
      m.metadataValues.should.have.property('temporalProtectExTime');
      m.metadataValues.temporalProtectExTime.should.equal(
        '2016-06-03T19:56:17.681154-07:00'
      );
      return db.documents.wipe({
        uri: 'tempDoc2.json',
        temporalCollection: 'temporalCollection'
      }).result();
    }).then(function(response){
      done();
    }).catch(done);
  });
  // Jenkins skips archivePath test: https://bugtrack.marklogic.com/45783
  it('should protect a temporal document with a duration and archivePath', function(done) {
    // TODO - Can we make a version of this test that works in different environments, such as Jenkins?
    this.skip();
    db.documents.write({
      documents: {
        uri: 'tempDoc3.json',
        content: content
      },
      temporalCollection: 'temporalCollection'
    }).result(function(response){
      return db.documents.protect({
        uri: 'tempDoc3.json',
        temporalCollection: 'temporalCollection',
        duration: 'PT0S',
        archivePath: archiveFile
      }).result();
    }).then(function(response){
      response.uri.should.equal('tempDoc3.json');
      response.temporalCollection.should.equal('temporalCollection');
      response.level.should.equal(DEFAULT_LEVEL);
      return db.documents.read({
        uris: 'tempDoc3.json',
        categories: 'metadataValues'
      }).result();
    }).then(function(response){
      var m = response[0];
      m.should.have.property('metadataValues');
      m.metadataValues.should.have.property('temporalDocURI');
      m.metadataValues.temporalDocURI.should.equal('tempDoc3.json');
      m.metadataValues.should.have.property('temporalArchivePaths');
      m.metadataValues.temporalArchivePaths.should.equal(archiveFile);
      m.metadataValues.should.have.property('temporalArchiveStatus');
      m.metadataValues.temporalArchiveStatus.should.equal('succeeded');
      m.metadataValues.should.have.property('temporalArchiveTime');
      return db.documents.wipe({
        uri: 'tempDoc3.json',
        temporalCollection: 'temporalCollection'
      }).result();
    }).then(function(response){
      fs.unlinkSync(archiveFile);
      done();
    }).catch(done);
  });
  it('should protect a temporal document twice', function(done) {
    db.documents.write({
      documents: {
        uri: 'tempDoc4.json',
        content: content
      },
      temporalCollection: 'temporalCollection'
    }).result(function(response){
      return db.documents.protect({
        uri: 'tempDoc4.json',
        temporalCollection: 'temporalCollection',
        expireTime: '2016-01-01T12:34:56.7890-07:00',
        level: 'noUpdate'
      }).result();
    }).then(function(response){
      response.uri.should.equal('tempDoc4.json');
      response.temporalCollection.should.equal('temporalCollection');
      response.level.should.equal('noUpdate');
      return db.documents.protect({
        uri: 'tempDoc4.json',
        temporalCollection: 'temporalCollection',
        expireTime: '2016-01-01T12:34:56.7890-07:00',
        level: 'noUpdate'
      }).result();
    }).then(function(response){
      response.uri.should.equal('tempDoc4.json');
      response.temporalCollection.should.equal('temporalCollection');
      response.level.should.equal('noUpdate');
      return db.documents.wipe({
        uri: 'tempDoc4.json',
        temporalCollection: 'temporalCollection'
      }).result();
    }).then(function(response){
      done();
    }).catch(done);
  });
});