Globalyzer Server and Rule Sets - Revision history

Rdaly at 20:41, 14 June 2019

2019-06-14T20:41:05Z

← Older revision		Revision as of 20:41, 14 June 2019
Line 295:		Line 295:

	[[File:Gz 5 Result.png]]		[[File:Gz 5 Result.png]]

			== Clean User History==

			When users login to their Globalyzer Server accounts, that login history is stored on the Globalyzer Server.
			Likewise, when users log into the Globalyzer Client (Workbench or Lite) and execute scans, that login and scanning history is also stored on the Server.

			Administrators and Managers can view and delete this data on the Server by selecting '''Clean User History''' from their home page.

			Additionally, a cron job runs nightly to remove data. Our hosted server is configured to keep data for 90 days. If you install your own Enterprise Server, this value is configurable via the '''gzserver.cleanup.daysToKeep''' setting in the GzserverConfig.groovy file. If not configured, it defaults to 90 days.

Rdaly: /* Unique Options for Java Rule Sets */

2019-06-14T19:52:35Z

Unique Options for Java Rule Sets

← Older revision		Revision as of 19:52, 14 June 2019
Line 227:		Line 227:
	</pre>		</pre>

	== ~~Unique Options for~~ Java Rule Sets ==		== Identifying Class or Variable Type in Java Rule Sets ==
	=== Introduction ===		=== Introduction ===
	Globalyzer Server version 5 introduced new types of rules for Java rule sets based on a improved, in-depth i18n parsing.		Globalyzer Server version 5 introduced new types of rules for Java rule sets based on a improved, in-depth i18n parsing.

Rdaly: /* Example */

2019-06-14T19:51:23Z

Example

← Older revision		Revision as of 19:51, 14 June 2019
Line 282:		Line 282:
	* Help Page: <blank>		* Help Page: <blank>

	The String Method ~~Detection~~ rule would be configured the following way:		The String Method Pattern retention rule would be configured the following way:
	* Name: '''User Interface Label setText'''		* Name: '''User Interface Label setText'''
	* Pattern: '''setText'''		* Pattern: '''setText'''
Line 290:		Line 290:

	When the rules are applied:		When the rules are applied:
	* The string passed to the Dbg variable ''setText'' method is filtered out and does not show up as a candidate issue		* The string passed to the Dbg variable ''setText'' method is filtered out and does not show up as a candidate issue.
	* The string passed to the Label variable ''setText'' method is detected and does show up as a candidate issue		* The string passed to the Label variable ''setText'' method is detected and does show up as a candidate issue.


	[[File:Gz 5 Result.png]]		[[File:Gz 5 Result.png]]

Rdaly at 19:47, 14 June 2019

2019-06-14T19:47:13Z

← Older revision		Revision as of 19:47, 14 June 2019
Line 228:		Line 228:

	== Unique Options for Java Rule Sets ==		== Unique Options for Java Rule Sets ==
	== Introduction ===		=== Introduction ===
	Globalyzer Server version 5 introduced new types of rules for Java rule sets based on a improved, in-depth i18n parsing.		Globalyzer Server version 5 introduced new types of rules for Java rule sets based on a improved, in-depth i18n parsing.

Rdaly at 19:46, 14 June 2019

2019-06-14T19:46:23Z

← Older revision		Revision as of 19:46, 14 June 2019
Line 226:		Line 226:
	RES3=Naviguer		RES3=Naviguer
	</pre>		</pre>

			== Unique Options for Java Rule Sets ==
			== Introduction ===
			Globalyzer Server version 5 introduced new types of rules for Java rule sets based on a improved, in-depth i18n parsing.

			Say that you want to filter strings passed as parameters to a method called '''get''', which is a fairly common method name. You can specify the class name on which the rule should be applied. Let's say the ''I18nUtil'' class and the ''UIUtil'' both have a ''''get'''' method.
			* You can specify a string method filter on '''get''' for variables of type ''I18nUtil'' and
			* You can specify a string method pattern on '''get''' for variables of type ''UIUtil''.
			* Static methods are also handled (''I18nUtil.get("string")'' for example)
			* You can also have an overarching '''get''' rule for all variable types by leaving the ''Class or Variable Type(s)'' field empty, as opposed to listing all the class types on which a detection or a filter must apply.

			=== User Interface ===
			Class names are specified as part of the rules. The following UI shows how to configure a new <code>String Method Filter</code> for the <code>smalljava</code> illustrative rule set.

			[[File:RS with Class or Variable Type.png]]
			* '''Name''': That the name of the rule. It could be something like <code>i18n get</code>
			* '''Pattern''': That is the pattern which would match the method name. It could be something as simple as <code>get</code>
			* '''Class or Variable Type(s)''': This is a pattern which would match the class name. It could be something like <code>company.project.util.I18nUtil</code>
			* '''Description''': The description or the reason for this filter could be something like "I18nUtil get method string parameters do not need to be externalized into a resource bundle for i18n purposes"
			* '''Help Page''': The link to a more verbose help page which may indicate the context and the reason for the filter.

			'''Note''': The value of '''Class/Variable Type(s)''' is a string delimited list of '''fully qualified classes and types'''. If the field is empty, the methods are filtered/detected on all variables or classes accordingly.

			=== Type of Rules ===
			The first rules to be impacted are Java String Method Filters and Java String Method Pattern retection rules. Passing a String parameter to a Java method has the added level of knowing the variable class name. Filtering on a method called "setText" will allow to differentiate between classes or objects of different types with that method being invoked. This will make for better rules and finer results.

			As Lingoport explores other possibilities, other rules and other programming languages will be covered.

			=== Example ===

			<pre>
			import company.project.util.Dbg; // A fully qualified class name
			import company.project.ui.*; // Label is in the company.project.ui package.
			[...]
			Dbg dbg = Dbg.getInstance();
			Label lbl = new Label();
			[...]
			dbg.setText("Create User action taken.");
			[...]
			label.setText("Menu");
			</pre>


			This snippet of code does have strings.

			* The class '''<code>company.project.Dbg</code>''' is a debug class and the text method puts the String parameter into a database for support purposes. That string is not visible to the end user. In that instance, the <code>setText</code> method on a variable of type <code>company.project.util.Dbg</code> should be filtered. The Strings in statements like <code>Dbg.setText("a string");</code> or <code>company.project.util.Dbg.setText("another string");</code> would also be filtered.

			* The variable '''<code>lbl</code>''' of class <code>company.project.ui.Label</code> represents a text area in the User Interface and the <code>setText</code> method passes a user visible string. The string <code>Menu</code> passed to this <code>setText</code> method should be flagged: It needs to be externalized out of the code into a resource bundle.

			The String Method Filter rule would be configured the following way:
			* Name: '''Debug setText'''
			* Pattern: '''setText'''
			* Class or Variable Type(s): '''company.project.util.Dbg'''
			* Description: '''String parameters passed to the Debug setText must not be externalized and translated.'''
			* Help Page: <blank>

			The String Method Detection rule would be configured the following way:
			* Name: '''User Interface Label setText'''
			* Pattern: '''setText'''
			* Class or Variable Type(s): '''company.project.ui.Label'''
			* Description: '''String parameters passed to the Label setText method must be externalized and translated.'''
			* Help Page: <blank>

			When the rules are applied:
			* The string passed to the Dbg variable ''setText'' method is filtered out and does not show up as a candidate issue
			* The string passed to the Label variable ''setText'' method is detected and does show up as a candidate issue


			[[File:Gz 5 Result.png]]

Rdaly: /* Concatenation Detection in Globalyzer Workbench */

2019-06-12T19:16:23Z

Concatenation Detection in Globalyzer Workbench

← Older revision		Revision as of 19:16, 12 June 2019
Line 226:		Line 226:
	RES3=Naviguer		RES3=Naviguer
	</pre>		</pre>

	~~== Concatenation Detection in Globalyzer Workbench ==~~

	~~String Concatenation is marked with a <b>C</b> priority on detected strings according to the following rules:~~

	* String literal either begins or ends with white space.
	~~<pre>~~
	~~String myString = " this";~~
	~~String myString2 = "that ";~~
	~~</pre>~~

	* String literal is preceded or followed by a concatenation operator. Concatenation operators vary by language. Any Locale Sensitive Method with priority 0 is marked as a concatenation issue.
	** In Java, the concatenation operators are "+" and "+=".
	~~<pre>~~
	~~String myString3 = "hello" + " "~~
	~~myString3 += "there";~~
	~~</pre>~~

	* The String literal is a parameter to an Locale Sensitive Method with priority 0.
	** In Java, <code>concat</code> and <code>append</code> methods for <code>java.lang.String</code> are Locale Sensitive Methods with priority 0.
	~~<pre>~~
	~~myString3.append("something");~~
	~~myString3.concat("another thing");~~
	~~</pre>~~

	~~When running a scan for that language, Globalyzer Workbench will detect the concatenated strings. Here is the Scan Results window with the Editor Pane pointing to one concatenation:~~

	~~[[File:Concatenation In Workbench.png]]~~

Rdaly: /* Concatenation Detection in Globalyzer Workbench */

2019-06-12T19:14:39Z

Concatenation Detection in Globalyzer Workbench

← Older revision		Revision as of 19:14, 12 June 2019
Line 237:		Line 237:
	</pre>		</pre>

	* String literal is preceded or followed by a concatenation operator. Concatenation operators vary by language. ~~<LIST OF CONCATENATION OPS TO BE FILLED IN>~~		* String literal is preceded or followed by a concatenation operator. Concatenation operators vary by language. Any Locale Sensitive Method with priority 0 is marked as a concatenation issue.
	** In Java, the concatenation operators are "+" and "+=".		** In Java, the concatenation operators are "+" and "+=".
	<pre>		<pre>

Rdaly: /* Concatenation Detection in Globalyzer Workbench */

2019-06-12T18:44:13Z

Concatenation Detection in Globalyzer Workbench

← Older revision		Revision as of 18:44, 12 June 2019
Line 245:		Line 245:

	* The String literal is a parameter to an Locale Sensitive Method with priority 0.		* The String literal is a parameter to an Locale Sensitive Method with priority 0.
	** ~~InJava~~, <code>concat</code> and <code>append</code> methods for <code>java.lang.String</code> are ~~LSMs~~ with priority 0.		** In Java, <code>concat</code> and <code>append</code> methods for <code>java.lang.String</code> are Locale Sensitive Methods with priority 0.
	<pre>		<pre>
	myString3.append("something");		myString3.append("something");

Rdaly: /* Concatenation Detection in Globalyzer Workbench */

2019-06-12T18:43:10Z

Concatenation Detection in Globalyzer Workbench

← Older revision		Revision as of 18:43, 12 June 2019
Line 251:		Line 251:
	</pre>		</pre>

			When running a scan for that language, Globalyzer Workbench will detect the concatenated strings. Here is the Scan Results window with the Editor Pane pointing to one concatenation:

	When running a scan for that language, Workbench will detect the concatenated strings. Here is the Scan Results window with the Editor Pane pointing to one concatenation:

	[[File:Concatenation In Workbench.png]]		[[File:Concatenation In Workbench.png]]

Rdaly: /* Example */

2019-06-12T18:42:37Z

Example

← Older revision		Revision as of 18:42, 12 June 2019
Line 251:		Line 251:
	</pre>		</pre>

	~~= Example =~~

	When running a scan for that language, Workbench will detect the concatenated strings. Here is the Scan Results window with the Editor Pane pointing to one concatenation:		When running a scan for that language, Workbench will detect the concatenated strings. Here is the Scan Results window with the Editor Pane pointing to one concatenation:

	[[File:Concatenation In Workbench.png]]		[[File:Concatenation In Workbench.png]]