You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/08/06 02:37:00 UTC

[jira] [Commented] (METRON-711) StellarShell assigns variables even if an exception was thrown in the statement.

    [ https://issues.apache.org/jira/browse/METRON-711?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16115592#comment-16115592 ] 

ASF GitHub Bot commented on METRON-711:
---------------------------------------

GitHub user ottobackwards opened a pull request:

    https://github.com/apache/metron/pull/686

    METRON-711 STELLAR SHELL Do not set variables when exceptions are thrown from assignment.

    This PR changes the behavior of the Stellar Shell such that when doing variable assignments ( VAR := EXPRESSION ) that result in an exception ( foo := TO_UPPER(IN) ) do not continue to set / create foo after catching the exception.
    
    
    ## Testing 
    
    - Start the stellar shell
    - Execute a statement that may throw an exception, the easiest is an invalid expression like
    ```bash
    > foo := TO_UPPER(IN)
    ```
    
    - Verify that there is a statement that the variable will not be set
    - Verify that the exception and stack is printed
    - Verify that the variable was not in fact set:
    
    ```bash
    > %vars
    ```
    
    Also, test creating a variable, and that it is not modified
    
    ```bash
    > bar := 'one'
    > bar := TO_UPPER(IN)
    > bar
    > %vars
    ```
    
    
    ## Pull Request Checklist
    
    Thank you for submitting a contribution to Apache Metron.  
    Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.  
    Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.  
    
    
    In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
    
    ### For all changes:
    - [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel). 
    - [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    - [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    
    ### For code changes:
    - [x] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
    - [x] Have you included steps or a guide to how the change may be verified and tested manually?
    - [x] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
      ```
      mvn -q clean integration-test install && build_utils/verify_licenses.sh 
      ```
    
    - [ ] Have you written or updated unit tests and or integration tests to verify your changes?
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)? 
    - [x] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
    
    ### For documentation related changes:
    - [ ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
    
      ```
      cd site-book
      mvn site
      ```
    
    #### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
    It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/ottobackwards/metron stellar_shell_ex

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/metron/pull/686.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #686
    
----
commit 215dc969026fa557a0a0f3efb9fe2bc170666b9a
Author: Otto Fowler <ot...@gmail.com>
Date:   2017-08-06T02:14:51Z

    Do not set variables when exceptions are thrown from assignment.
    Also remove executeStellar which is not required, if it doesn't eat the exception

----


> StellarShell assigns variables even if an exception was thrown in the statement.
> --------------------------------------------------------------------------------
>
>                 Key: METRON-711
>                 URL: https://issues.apache.org/jira/browse/METRON-711
>             Project: Metron
>          Issue Type: Bug
>    Affects Versions: 0.4.1
>            Reporter: Justin Leet
>            Assignee: Otto Fowler
>            Priority: Minor
>
> Discovered while reviewing https://github.com/apache/incubator-metron/pull/438.
> If an exception is thrown during Stellar execution, the exception will be logged, and null is returned.  The assignment then goes through as normal, leaving the assigned variable null.
> Seen using THREAT_TRIAGE_REMOVE with a String arg, instead of a List.  Resulted in a null conf variable.
> {code}
> [Stellar]>>> conf := THREAT_TRIAGE_ADD(conf, [triage])
> [Stellar]>>> conf := THREAT_TRIAGE_REMOVE(conf, 'Abnormal DNS Port')
> [!] Unable to execute: java.lang.String cannot be cast to java.util.List
> org.apache.metron.common.dsl.ParseException: Unable to execute: java.lang.String cannot be cast to java.util.List
> 	at org.apache.metron.common.stellar.StellarCompiler.getResult(StellarCompiler.java:409)
> 	at org.apache.metron.common.stellar.BaseStellarProcessor.parse(BaseStellarProcessor.java:127)
> 	at org.apache.metron.common.stellar.shell.StellarExecutor.execute(StellarExecutor.java:275)
> 	at org.apache.metron.common.stellar.shell.StellarShell.executeStellar(StellarShell.java:373)
> 	at org.apache.metron.common.stellar.shell.StellarShell.handleStellar(StellarShell.java:276)
> 	at org.apache.metron.common.stellar.shell.StellarShell.execute(StellarShell.java:412)
> 	at org.jboss.aesh.console.AeshProcess.run(AeshProcess.java:53)
> 	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
> 	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
> 	at java.lang.Thread.run(Thread.java:745)
> Caused by: java.lang.ClassCastException: java.lang.String cannot be cast to java.util.List
> 	at org.apache.metron.management.ThreatTriageFunctions$RemoveStellarTransformation.apply(ThreatTriageFunctions.java:232)
> 	at org.apache.metron.common.stellar.StellarCompiler.exitTransformationFunc(StellarCompiler.java:267)
> 	at org.apache.metron.common.stellar.generated.StellarParser$TransformationFuncContext.exitRule(StellarParser.java:1689)
> 	at org.antlr.v4.runtime.Parser.triggerExitRuleEvent(Parser.java:422)
> 	at org.antlr.v4.runtime.Parser.exitRule(Parser.java:632)
> 	at org.apache.metron.common.stellar.generated.StellarParser.functions(StellarParser.java:1712)
> 	at org.apache.metron.common.stellar.generated.StellarParser.arithmetic_operands(StellarParser.java:1846)
> 	at org.apache.metron.common.stellar.generated.StellarParser.arithmetic_expr_mul(StellarParser.java:1609)
> 	at org.apache.metron.common.stellar.generated.StellarParser.arithmetic_expr(StellarParser.java:1469)
> 	at org.apache.metron.common.stellar.generated.StellarParser.transformation_expr(StellarParser.java:308)
> 	at org.apache.metron.common.stellar.generated.StellarParser.transformation(StellarParser.java:149)
> 	at org.apache.metron.common.stellar.BaseStellarProcessor.parse(BaseStellarProcessor.java:126)
> 	... 8 more
> [Stellar]>>> conf
> [Stellar]>>> conf
> [Stellar]>>> conf := THREAT_TRIAGE_REMOVE(conf, ['Abnormal DNS Port'])
> [Stellar]>>> conf
> {
>   "enrichment" : {
>     "fieldMap" : { },
>     "fieldToTypeMap" : { },
>     "config" : { }
>   },
>   "threatIntel" : {
>     "fieldMap" : { },
>     "fieldToTypeMap" : { },
>     "config" : { },
>     "triageConfig" : {
>       "riskLevelRules" : [ ],
>       "aggregator" : "MAX",
>       "aggregationConfig" : { }
>     }
>   },
>   "configuration" : { }
> }
> {code}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)