apps-script-samples/sheets/api/test_spreadsheet_snippets.gs at master · TurtleVsPython/apps-script-samples · 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
var snippets = new Snippets();
var helpers = new Helpers();

/**
 * A simple exists assertion check. Expects a value to exist. Errors if DNE.
 * @param {any} value A value that is expected to exist.
 */
function expectToExist(value) {
  if (value) {
    console.log('TEST: Exists');
  } else {
    throw new Error('TEST: DNE');
  }
}

/**
 * A simple exists assertion check for primatives (no nested objects).
 * Expects actual to equal expected. Logs the output.
 * @param {any} actual The actual value.
 * @param {any} expected The expected value.
 */
function expectToEqual(actual, expected) {
  console.log('TEST: actual: %s = expected: %s', actual, expected);
  if (actual !== expected) {
    console.log('TEST: actual: %s expected: %s', actual, expected);
  }
}

/**
 * Runs all tests.
 */
function RUN_ALL_TESTS() {
  itShouldCreateASpreadsheet();
  itShouldBatchUpdateASpreadsheet();
  itShouldGetSpreadsheetValues();
  itShouldBatchGetSpreadsheetValues();
  itShouldUpdateSpreadsheetValues();
  itShouldBatchUpdateSpreadsheetValues();
  itShouldAppendValuesToASpreadsheet();
  itShouldCreatePivotTables();
  itShouldConditionallyFormat();
}

/**
 * Tests creating a spreadsheet.
 */
function itShouldCreateASpreadsheet() {
  var spreadsheetId = snippets.create('Title');
  expectToExist(spreadsheetId);
  helpers.deleteFileOnCleanup(spreadsheetId);
}

/**
 * Tests updating a spreadsheet.
 */
function itShouldBatchUpdateASpreadsheet() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  helpers.populateValues(spreadsheetId);
  var result = snippets.batchUpdate(spreadsheetId, 'New Title', 'Hello', 'Goodbye');
  var replies = result.replies;
  expectToEqual(replies.length, 2);
  var findReplaceResponse = replies[1].findReplace;
  expectToEqual(findReplaceResponse.occurrencesChanged, 100);
}

/**
 * Tests getting a spreadsheet value.
 */
function itShouldGetSpreadsheetValues() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  helpers.populateValues(spreadsheetId);
  var result = snippets.getValues(spreadsheetId, 'A1:C2');
  var values = result.values;
  expectToEqual(values.length, 2);
  expectToEqual(values[0].length, 3);
}

/**
 * Tests batch getting spreadsheet values.
 */
function itShouldBatchGetSpreadsheetValues() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  helpers.populateValues(spreadsheetId);
  var result = snippets.batchGetValues(spreadsheetId, ['A1:A3', 'B1:C1']);
  expectToExist(result);
  expectToEqual(result.length, 2);
  var values = result[0];
  expectToEqual(result.valueRanges[0].values.length, 3);
}

/**
 * Tests updating spreadsheet values.
 */
function itShouldUpdateSpreadsheetValues() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  var result = snippets.updateValues(spreadsheetId, 'A1:B2', 'USER_ENTERED', [
    ['A', 'B'],
    ['C', 'D']
  ]);
  expectToEqual(result.updatedRows, 2);
  expectToEqual(result.updatedColumns, 2);
  expectToEqual(result.updatedCells, 4);
}

/**
 * Test batch updating spreadsheet values.
 */
function itShouldBatchUpdateSpreadsheetValues() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  var result = snippets.batchUpdateValues(spreadsheetId, 'A1:B2', 'USER_ENTERED', [
    ['A', 'B'],
    ['C', 'D']
  ]);
  expectToEqual(result.totalUpdatedRows, 2);
  expectToEqual(result.totalUpdatedColumns, 2);
  expectToEqual(result.totalUpdatedCells, 4);
}

/**
 * Test appending values to a spreadsheet.
 */
function itShouldAppendValuesToASpreadsheet() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  helpers.populateValues(spreadsheetId);
  var result = snippets.appendValues(spreadsheetId, 'Sheet1', 'USER_ENTERED', [
    ['A', 'B'],
    ['C', 'D']
  ]);
  var updates = result.updates;
  expectToEqual(updates.updatedRows, 2);
  expectToEqual(updates.updatedColumns, 2);
  expectToEqual(updates.updatedCells, 4);
}

/**
 * Test creating pivot tables.
 */
function itShouldCreatePivotTables() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  helpers.populateValues(spreadsheetId);
  var result = snippets.pivotTable(spreadsheetId);
  expectToExist(result);
}

/**
 * Test conditionally formatting spreadsheets.
 */
function itShouldConditionallyFormat() {
  var spreadsheetId = helpers.createTestSpreadsheet();
  helpers.populateValues(spreadsheetId);
  var result = snippets.conditionalFormatting(spreadsheetId);
  expectToExist(spreadsheetId);
  expectToEqual(result.replies.length, 2);
}