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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 95442 - (hide annotations)
Thu Jul 17 13:27:51 2014 UTC (5 years, 6 months ago) by schmisam
File size: 15324 byte(s)
Added rule for missing creation procedures with no arguments
Added tests for said rule.


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23