/[eiffelstudio]/branches/eth/eve/Src/framework/code_analysis/ca_code_analyzer.e
ViewVC logotype

Contents of /branches/eth/eve/Src/framework/code_analysis/ca_code_analyzer.e

Parent Directory Parent Directory | Revision Log Revision Log


Revision 95465 - (show annotations)
Sat Jul 19 15:10:12 2014 UTC (5 years, 6 months ago) by schmisam
File size: 15449 byte(s)
Added code analysis rule for creation of objects in loops
Added tests for the rule.


1 note
2 description: "THE Code Analyzer."
3 author: "Stefan Zurfluh"
4 date: "$Date$"
5 revision: "$Revision$"
6
7 class
8 CA_CODE_ANALYZER
9
10 inherit
11 SHARED_EIFFEL_PROJECT
12
13 CA_SHARED_NAMES
14
15 create
16 make
17
18 feature {NONE} -- Initialization
19
20 make
21 -- Initialization for `Current'.
22 do
23 create settings.make
24 create rules.make_caseless (100) -- Rule IDs should be case insensitive.
25
26 -- Adding the rules.
27 add_rule (create {CA_SELF_ASSIGNMENT_RULE}.make)
28 add_rule (create {CA_UNUSED_ARGUMENT_RULE}.make)
29 add_rule (create {CA_NPATH_RULE}.make (settings.preference_manager))
30 add_rule (create {CA_EMPTY_IF_RULE}.make)
31 add_rule (create {CA_FEATURE_NEVER_CALLED_RULE}.make)
32 add_rule (create {CA_CQ_SEPARATION_RULE}.make)
33 add_rule (create {CA_UNNEEDED_OT_LOCAL_RULE}.make)
34 add_rule (create {CA_UNNEEDED_OBJECT_TEST_RULE}.make) -- Needs type info.
35 add_rule (create {CA_NESTED_COMPLEXITY_RULE}.make (settings.preference_manager))
36 add_rule (create {CA_MANY_ARGUMENTS_RULE}.make (settings.preference_manager))
37 add_rule (create {CA_CREATION_PROC_EXPORTED_RULE}.make)
38 add_rule (create {CA_VARIABLE_NOT_READ_RULE}.make)
39 add_rule (create {CA_SEMICOLON_ARGUMENTS_RULE}.make)
40 add_rule (create {CA_VERY_LONG_ROUTINE_RULE}.make (settings.preference_manager))
41 add_rule (create {CA_VERY_BIG_CLASS_RULE}.make (settings.preference_manager))
42 add_rule (create {CA_FEATURE_SECTION_COMMENT_RULE}.make)
43 add_rule (create {CA_FEATURE_NOT_COMMENTED_RULE}.make)
44 add_rule (create {CA_BOOLEAN_RESULT_RULE}.make)
45 add_rule (create {CA_BOOLEAN_COMPARISON_RULE}.make)
46 add_rule (create {CA_VERY_SHORT_IDENTIFIER_RULE}.make (settings.preference_manager))
47 add_rule (create {CA_VERY_LONG_IDENTIFIER_RULE}.make (settings.preference_manager))
48 add_rule (create {CA_MISSING_IS_EQUAL_RULE}.make)
49 add_rule (create {CA_SIMPLIFIABLE_BOOLEAN_RULE}.make)
50 add_rule (create {CA_SELF_COMPARISON_RULE}.make)
51 add_rule (create {CA_TODO_RULE}.make)
52 add_rule (create {CA_WRONG_LOOP_ITERATION_RULE}.make)
53 add_rule (create {CA_INSPECT_INSTRUCTIONS_RULE}.make (settings.preference_manager))
54 add_rule (create {CA_ATTRIBUTE_TO_LOCAL_RULE}.make)
55 add_rule (create {CA_EMPTY_EFFECTIVE_ROUTINE_RULE}.make)
56 add_rule (create {CA_IF_ELSE_NOT_EQUAL_RULE}.make)
57 add_rule (create {CA_SHORT_CIRCUIT_IF_RULE}.make)
58 add_rule (create {CA_ITERABLE_LOOP_RULE}.make) -- Needs type info.
59 add_rule (create {CA_COUNT_EQUALS_ZERO_RULE}.make) -- Needs type info.
60 add_rule (create {CA_DEEPLY_NESTED_IF_RULE}.make (settings.preference_manager))
61 add_rule (create {CA_UNNEEDED_HELPER_VARIABLE_RULE}.make (settings.preference_manager))
62 add_rule (create {CA_UNNEEDED_PARENTHESES_RULE}.make)
63 add_rule (create {CA_CLASS_NAMING_CONVENTION_RULE}.make)
64 add_rule (create {CA_FEATURE_NAMING_CONVENTION_RULE}.make)
65 add_rule (create {CA_LOCAL_NAMING_CONVENTION_RULE}.make (settings.preference_manager))
66 add_rule (create {CA_ARGUMENT_NAMING_CONVENTION_RULE}.make (settings.preference_manager))
67 add_rule (create {CA_UNNECESSARY_SIGN_OPERATOR_RULE}.make)
68 add_rule (create {CA_EMPTY_UNCOMMENTED_ROUTINE_RULE}.make)
69 add_rule (create {CA_UNNEEDED_ACCESSOR_FUNCTION_RULE}.make)
70 add_rule (create {CA_MERGEABLE_FEATURE_CLAUSES_RULE}.make)
71 add_rule (create {CA_EMPTY_RESCUE_CLAUSE_RULE}.make)
72 add_rule (create {CA_INSPECT_NO_WHEN_RULE}.make)
73 add_rule (create {CA_EXPLICIT_REDUNDANT_INHERITANCE_RULE}.make)
74 add_rule (create {CA_UNDESIRABLE_COMMENT_CONTENT_RULE}.make (settings.preference_manager))
75 add_rule (create {CA_INHERIT_FROM_ANY_RULE}.make)
76 add_rule (create {CA_DOUBLE_NEGATION_RULE}.make)
77 add_rule (create {CA_EMPTY_LOOP_RULE}.make)
78 add_rule (create {CA_MISSING_CREATION_PROC_WITHOUT_ARGS_RULE}.make)
79 add_rule (create {CA_COMMENT_NOT_WELL_PHRASED_RULE}.make)
80 add_rule (create {CA_OBJECT_CREATION_WITHIN_LOOP_RULE}.make)
81
82 settings.initialize_rule_settings (rules)
83
84 create classes_to_analyze.make
85 create rule_violations.make (100)
86 create completed_actions
87 create output_actions
88
89 create ignoredby.make (25)
90 create library_class.make (25)
91 create nonlibrary_class.make (25)
92 end
93
94 feature -- Analysis interface
95
96 add_completed_action (a_action: attached PROCEDURE [ANY, TUPLE [ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]]]])
97 -- Adds `a_action' to the list of procedures that will be
98 -- called when analysis has completed.
99 do
100 completed_actions.extend (a_action)
101 end
102
103 add_output_action (a_action: attached PROCEDURE [ANY, TUPLE [READABLE_STRING_GENERAL]])
104 -- Adds `a_action' to the procedures that are called for outputting status. The final results
105 -- (rule violations) are not given to these procedures.
106 do
107 output_actions.extend (a_action)
108 end
109
110 analyze
111 -- Analyze all the classes that have been added.
112 require
113 not is_running
114 local
115 l_rules_checker: CA_ALL_RULES_CHECKER
116 l_task: CA_RULE_CHECKING_TASK
117 l_rules_to_check: LINKED_LIST [CA_RULE]
118 do
119 is_running := True
120
121 create l_rules_checker.make
122 create l_rules_to_check.make
123 across rules as l_rules loop
124 l_rules.item.clear_violations
125 if is_rule_checkable (l_rules.item) then
126 l_rules_to_check.extend (l_rules.item)
127 -- Here we only prepare standard rules. The rule checking task will iterate again
128 -- through the rules and run the analysis on the enabled rules.
129 if attached {CA_STANDARD_RULE} l_rules.item as l_std_rule then
130 l_std_rule.prepare_checking (l_rules_checker)
131 end
132 end
133 end
134
135 create l_task.make (l_rules_checker, l_rules_to_check, classes_to_analyze, agent analysis_completed)
136 l_task.set_output_actions (output_actions)
137 if attached rota as l_rota then
138 rota.run_task (l_task)
139 else
140 -- No ROTA task is available, we execute the task synchronously.
141 from
142
143 until
144 not l_task.has_next_step
145 loop
146 l_task.step
147 end
148 end
149 end
150
151 is_rule_checkable (a_rule: attached CA_RULE): BOOLEAN
152 -- Will `a_rule' be checked based on the current preferences and based on the current
153 -- checking scope?
154 do
155 Result := a_rule.is_enabled.value
156 and then (system_wide_check or else (not a_rule.is_system_wide))
157 and then is_severity_enabled (a_rule.severity)
158 end
159
160 clear_classes_to_analyze
161 -- Removes all classes that have been added to the list of classes
162 -- to analyze.
163 do
164 classes_to_analyze.wipe_out
165 end
166
167 add_whole_system
168 -- Adds all the classes that are part of the current system. Classes of referenced libraries
169 -- will not be added.
170 do
171 across
172 eiffel_universe.groups as l_groups
173 loop
174 -- Only load top-level clusters, as the others will be loaded recursively afterwards.
175 if attached {CLUSTER_I} l_groups.item as l_cluster and then l_cluster.parent_cluster = Void then
176 add_cluster (l_cluster)
177 end
178 end
179
180 system_wide_check := True
181 end
182
183 add_cluster (a_cluster: attached CLUSTER_I)
184 -- Add all classes of cluster `a_cluster'.
185 do
186 system_wide_check := False
187
188 if a_cluster.classes /= Void then
189 across a_cluster.classes as ic loop
190 add_class (ic.item)
191 end
192 end
193
194 if a_cluster.sub_clusters /= Void then
195 across a_cluster.sub_clusters as ic loop
196 add_cluster (ic.item)
197 end
198 end
199 end
200
201 add_group (a_group: attached CONF_GROUP)
202 -- Add all classes of the configuration group `a_group'.
203 require
204 a_group_not_void: a_group /= Void
205 do
206 if a_group.classes /= Void then
207 across a_group.classes as ic loop
208 add_class (ic.item)
209 end
210 end
211 end
212
213 add_classes (a_classes: attached ITERABLE [attached CONF_CLASS])
214 -- Add the classes `a_classes'.
215 do
216 system_wide_check := False
217
218 across a_classes as l_classes loop
219 add_class (l_classes.item)
220 end
221 end
222
223 add_class (a_class: attached CONF_CLASS)
224 -- Adds class `a_class'.
225 do
226 system_wide_check := False
227
228 if attached {EIFFEL_CLASS_I} a_class as l_eiffel_class
229 and then attached l_eiffel_class.compiled_class as l_compiled
230 then
231 classes_to_analyze.extend (l_compiled)
232
233 extract_indexes (l_compiled)
234 else
235 output_actions.call ([ca_messages.class_skipped (a_class.name)])
236 end
237 end
238
239
240 force_preferences (a_preferences: LIST [TUPLE [rule_id: READABLE_STRING_GENERAL; preference_name: STRING; preference_value: READABLE_STRING_GENERAL]])
241 -- Forcefully set the preferences in `a_preferences' to the specified values,
242 -- overwriting the current ones.
243 local
244 l_full_preference_name: STRING
245 l_preference: PREFERENCE
246 do
247 -- Disable all rules.
248 across rules as ic loop
249 ic.item.is_enabled.set_value (False)
250 end
251
252 across a_preferences as ic loop
253 if rules.has_key (ic.item.rule_id) then
254 l_full_preference_name := rules.found_item.full_preference_name (ic.item.preference_name)
255 l_preference := preferences.get_preference (l_full_preference_name)
256
257 if attached l_preference then
258 l_preference.set_value_from_string (ic.item.preference_value)
259 else
260 output_actions.call ([ca_messages.preference_not_found (l_full_preference_name)])
261 end
262
263 else
264 output_actions.call ([ca_messages.rule_not_found (ic.item.rule_id)])
265 end
266 end
267 end
268
269
270 feature -- Properties
271
272 is_running: BOOLEAN
273 -- Is code analysis running?
274
275 rules: STRING_TABLE [CA_RULE]
276 -- Table containing the rules that will be used for analysis. Rules are indexed by ID.
277
278 add_rule (a_rule: CA_RULE)
279 -- Adds `a_rule' to the rules list.
280 require
281 not_added_yet: not rules.has (a_rule.id)
282 do
283 rules.extend (a_rule, a_rule.id)
284 ensure
285 added: rules.has (a_rule.id)
286 end
287
288 rule_violations: detachable HASH_TABLE [SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION], CLASS_C]
289 -- All found violations from the last analysis.
290
291 settings: CA_SETTINGS
292 -- The settings manager for Code Analysis.
293
294 preferences: PREFERENCES
295 -- Code Analysis preferences.
296 do Result := settings.preferences end
297
298 class_list: ITERABLE [CLASS_C]
299 -- List of classes that have been added.
300 do Result := classes_to_analyze end
301
302 feature {NONE} -- Implementation
303
304 csv_file_name: STRING = "last_analysis_result.csv"
305
306 csv_header: STRING = "Severity;Class;Location;Title;Description;Rule ID;Severity Score"
307
308 analysis_completed (a_exceptions: detachable ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]])
309 -- Will be called when the analysis task has finished. `a_exceptions'
310 -- contains a list of exception that occurred during analysis.
311 local
312 l_csv_writer: CA_CSV_WRITER
313 do
314 create l_csv_writer.make (eiffel_project.project_location.target_path.extended (csv_file_name), csv_header)
315
316 across rules as l_rules loop
317 across l_rules.item.violations as l_v loop
318 -- Check the ignore list.
319 if is_violation_valid (l_v.item) then
320 -- Make sure a list for this class exists in the hash table:
321 rule_violations.put (create {SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION]}.make, l_v.item.affected_class)
322 -- Add the violation.
323 rule_violations.at (l_v.item.affected_class).extend (l_v.item)
324 -- Log it.
325 l_csv_writer.add_line (l_v.item.csv_line)
326 end
327 end
328 end
329
330 l_csv_writer.close_file
331
332 clear_classes_to_analyze
333
334 is_running := False
335 completed_actions.call ([a_exceptions])
336 completed_actions.wipe_out
337 end
338
339 is_violation_valid (a_viol: attached CA_RULE_VIOLATION): BOOLEAN
340 -- Is the violation `a_viol' valid under the current settings
341 -- such as the rule ignore list of a class, or the library or
342 -- non-library status of a class?
343 local
344 l_affected_class: CLASS_C
345 l_rule: CA_RULE
346 do
347 l_affected_class := a_viol.affected_class
348 l_rule := a_viol.rule
349
350 Result := True
351
352 if ignoredby.has (l_affected_class)
353 and then (ignoredby.at (l_affected_class)).has (l_rule.id) then
354 Result := False
355 end
356
357 if (not l_rule.checks_library_classes) and then library_class.at (l_affected_class) then
358 Result := False
359 end
360
361 if (not l_rule.checks_nonlibrary_classes) and then nonlibrary_class.at (l_affected_class) then
362 Result := False
363 end
364 end
365
366 classes_to_analyze: LINKED_SET [CLASS_C]
367 -- List of classes that shall be analyzed.
368
369 system_wide_check: BOOLEAN
370 -- Shall the whole system be analyzed?
371
372 completed_actions: ACTION_SEQUENCE [TUPLE [ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]]]]
373 -- List of procedures to call when analysis has completed.
374
375 frozen rota: detachable ROTA_S
376 -- Accesses the rota service.
377 local
378 l_service_consumer: SERVICE_CONSUMER [ROTA_S]
379 do
380 create l_service_consumer
381 if attached l_service_consumer.service as l_service and then l_service.is_interface_usable then
382 Result := l_service
383 end
384 end
385
386 is_severity_enabled (a_severity: attached CA_RULE_SEVERITY): BOOLEAN
387 do
388 Result := (attached {CA_HINT} a_severity and settings.are_hints_enabled.value)
389 or else (attached {CA_SUGGESTION} a_severity and settings.are_suggestions_enabled.value)
390 or else (attached {CA_WARNING} a_severity and settings.are_warnings_enabled.value)
391 or else (attached {CA_ERROR} a_severity and settings.are_errors_enabled.value)
392 end
393
394 output_actions: ACTION_SEQUENCE [TUPLE [READABLE_STRING_GENERAL]]
395 -- Will be called whenever there is a message to output.
396
397 feature {NONE} -- Class-wide Options (From Indexing Clauses)
398
399 extract_indexes (a_class: attached CLASS_C)
400 -- Extracts options from the indexing clause of class `a_class'.
401 local
402 l_ast: CLASS_AS
403 l_ignoredby: LINKED_LIST [STRING_32]
404 do
405 create l_ignoredby.make
406 l_ignoredby.compare_objects -- We want to compare the actual strings.
407 -- Reset the class flags.
408 library_class.force (False, a_class)
409 nonlibrary_class.force (False, a_class)
410 l_ast := a_class.ast
411
412 if attached l_ast.internal_top_indexes as l_top then
413 search_indexing_tags (l_top, a_class, l_ignoredby)
414 end
415 if attached l_ast.internal_bottom_indexes as l_bottom then
416 search_indexing_tags (l_bottom, a_class, l_ignoredby)
417 end
418
419 ignoredby.force (l_ignoredby, a_class)
420 end
421
422 search_indexing_tags (a_clause: attached INDEXING_CLAUSE_AS; a_class: attached CLASS_C; a_ignoredby: attached LINKED_LIST [STRING_32])
423 -- Searches `a_clause' for settings relevant to code analysis.
424 local
425 l_item: STRING_32
426 do
427 across a_clause as ic loop
428 if attached ic.item.tag as l_tag then
429 if l_tag.name_32.same_string_general ("ca_ignoredby") then
430 -- Class wants to ignore certain rules.
431 across ic.item.index_list as l_list loop
432 l_item := l_list.item.string_value_32
433 l_item.prune_all ('%"')
434 a_ignoredby.extend (l_item)
435 end
436 elseif l_tag.name_32.is_equal ("ca_library") then
437 -- Class has information on whether it is a library class.
438 if not ic.item.index_list.is_empty then
439 l_item := ic.item.index_list.first.string_value_32
440 l_item.to_lower
441 l_item.prune_all ('%"')
442 if l_item.is_equal ("true") then
443 library_class.force (True, a_class)
444 elseif l_item.is_equal ("false") then
445 nonlibrary_class.force (True, a_class)
446 end
447 end
448 end
449 end
450 end
451 end
452
453 ignoredby: HASH_TABLE [LINKED_LIST [STRING_32], CLASS_C]
454 -- Maps classes to lists of rules (rule IDs) the class wants to be ignored by.
455
456 library_class, nonlibrary_class: HASH_TABLE [BOOLEAN, CLASS_C]
457 -- Stores classes that are marked as library or non-library classes.
458
459 invariant
460 -- law_of_non_contradiction: one class must not be both a library_class and a nonlibrary_class
461
462 end

Properties

Name Value
svn:eol-style native
svn:keywords Author Date ID Revision

  ViewVC Help
Powered by ViewVC 1.1.23