File: generate_jsdoc_test.py

package info (click to toggle)
aseba-plugin-blockly 20180211%2Bgit-3
  • links: PTS
  • area: non-free
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 64,568 kB
  • sloc: javascript: 504,479; xml: 7,976; python: 2,314; sh: 261; lisp: 24; makefile: 10
file content (167 lines) | stat: -rw-r--r-- 3,494 bytes parent folder | download | duplicates (2)
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
#!/usr/bin/env python
#
# Copyright 2013 The Closure Library Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required `by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


"""Unit test for generate_jsdoc."""

__author__ = 'nnaze@google.com (Nathan Naze)'


import re
import unittest

import generate_jsdoc


class InsertJsDocTestCase(unittest.TestCase):
  """Unit test for source.  Tests the parser on a known source input."""

  def testMatchFirstFunction(self):
    match = generate_jsdoc._MatchFirstFunction(_TEST_SOURCE)
    self.assertNotEqual(None, match)
    self.assertEqual('aaa, bbb, ccc', match.group('arguments'))

    match = generate_jsdoc._MatchFirstFunction(_INDENTED_SOURCE)
    self.assertNotEqual(None, match)
    self.assertEqual('', match.group('arguments'))

    match = generate_jsdoc._MatchFirstFunction(_ODD_NEWLINES_SOURCE)
    self.assertEquals('goog.\nfoo.\nbar\n.baz.\nqux',
                      match.group('identifier'))

  def testParseArgString(self):
    self.assertEquals(
        ['foo', 'bar', 'baz'],
        list(generate_jsdoc._ParseArgString('foo, bar, baz')))

  def testExtractFunctionBody(self):
    self.assertEquals(
        '\n  // Function comments.\n  return;\n',
        generate_jsdoc._ExtractFunctionBody(_TEST_SOURCE))

    self.assertEquals(
        '\n    var bar = 3;\n    return true;\n',
        generate_jsdoc._ExtractFunctionBody(_INDENTED_SOURCE, 2))

  def testContainsValueReturn(self):
    self.assertTrue(generate_jsdoc._ContainsReturnValue(_INDENTED_SOURCE))
    self.assertFalse(generate_jsdoc._ContainsReturnValue(_TEST_SOURCE))

  def testInsertString(self):
    self.assertEquals(
        'abc123def',
        generate_jsdoc._InsertString('abcdef', '123', 3))

  def testInsertJsDoc(self):
    self.assertEquals(
        _EXPECTED_INDENTED_SOURCE,
        generate_jsdoc.InsertJsDoc(_INDENTED_SOURCE))

    self.assertEquals(
        _EXPECTED_TEST_SOURCE,
        generate_jsdoc.InsertJsDoc(_TEST_SOURCE))

    self.assertEquals(
        _EXPECTED_ODD_NEWLINES_SOURCE,
        generate_jsdoc.InsertJsDoc(_ODD_NEWLINES_SOURCE))


_INDENTED_SOURCE = """\
  boo.foo.woo = function() {
    var bar = 3;
    return true;
  };
"""

_EXPECTED_INDENTED_SOURCE = """\
  /**
   * @return
   */
  boo.foo.woo = function() {
    var bar = 3;
    return true;
  };
"""


_TEST_SOURCE = """\

//  Random comment.

goog.foo.bar = function (aaa, bbb, ccc) {
  // Function comments.
  return;
};
"""

_EXPECTED_TEST_SOURCE = """\

//  Random comment.

/**
 * @param {} aaa
 * @param {} bbb
 * @param {} ccc
 */
goog.foo.bar = function (aaa, bbb, ccc) {
  // Function comments.
  return;
};
"""

_ODD_NEWLINES_SOURCE = """\
goog.
foo.
bar
.baz.
qux
   =

 function

(aaa,

bbb, ccc) {
  // Function comments.
  return;
};
"""

_EXPECTED_ODD_NEWLINES_SOURCE = """\
/**
 * @param {} aaa
 * @param {} bbb
 * @param {} ccc
 */
goog.
foo.
bar
.baz.
qux
   =

 function

(aaa,

bbb, ccc) {
  // Function comments.
  return;
};
"""

if __name__ == '__main__':
  unittest.main()