@dxworks/insider 2.9.1

package/.github/workflows/build.yml

@@ -0,0 +1,19 @@
+name: Build
+
+on:
+  push:
+    branches:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Java for publishing to GitHub Packages
+        uses: actions/setup-java@v3
+        with:
+          java-version: 11
+
+      - name: Gradle Build
+        run: gradle clean build

package/.github/workflows/release-docs.yml

@@ -0,0 +1,15 @@
+name: Release Docs
+on:
+  push:
+    branches:
+      - docs
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

package/.github/workflows/release-voyager.yml

@@ -0,0 +1,57 @@
+on:
+  push:
+    tags:
+      - 'v*-voyager'
+
+name: Create Release
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Tag Name
+        id: tag_name
+        run: |
+          echo ::set-output name=TAG_NAME::${GITHUB_REF#refs/tags/}
+
+      - name: Set Version
+        run: echo ${TAG_NAME} > src/main/resources/insider-version
+      - name: Build
+        run: gradle clean build
+      - name: Prepare Assets
+        run: |
+          mkdir insider
+          mkdir insider/results
+          cp README.md insider/README.md
+          cp build/libs/insider*.jar insider/insider.jar
+          cp bin/insider.sh insider/insider.sh
+          chmod +x insider/insider.sh
+          cp bin/insider.bat insider/insider.bat
+          cp instrument.yml insider/instrument.yml
+          cp languages.yml insider/languages.yml
+          cp -R config insider/config
+      - name: Create Archive
+        run: zip -r insider.zip insider
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Insider ${{ github.ref }}
+          draft: false
+          prerelease: false
+      - name: Upload Release Asset
+        id: upload-release-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./insider.zip
+          asset_name: insider-voyager.zip
+          asset_content_type: application/zip

package/.github/workflows/release.yml

@@ -0,0 +1,102 @@
+on:
+  push:
+    tags:
+      - 'v*'
+      - '!**-voyager'
+
+name: Create Release
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Extract Semver
+        id: semver_parser
+        run: |
+          semver=${TAG#"refs/tags/v"}
+          semver=${semver%"-voyager"}
+
+          echo ::set-output name=semver::$semver
+        env:
+          TAG: ${{ github.ref }}
+
+      - name: Set Version
+        run: echo ${{ steps.semver_parser.outputs.semver }} > src/main/resources/insider-version
+      - name: Build
+        run: gradle clean build
+      - name: Prepare Assets
+        run: |
+          mkdir insider
+          mkdir insider/results
+          cp README.md insider/README.md
+          cp build/libs/insider*.jar insider/insider.jar
+          cp bin/insider.sh insider/insider.sh
+          cp bin/insider.bat insider/insider.bat
+          chmod +x insider/insider.sh
+          cp languages.yml insider/languages.yml
+          cp -R config insider/config
+
+      - name: Create Archive
+        run: zip -r insider.zip insider
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          cache: 'npm'
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@dxworks'
+
+      - name: Prepare Node App
+        run: |
+          npm ci
+          npm run build
+
+
+      - name: Setup Version
+        run: |
+          ls -al node_modules/.bin
+          node_modules/.bin/json -I -f package.json -e "this.version='$VERSION'"
+        env:
+          VERSION: ${{ steps.semver_parser.outputs.semver }}
+
+      - name: Publish NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Node with NPM Package Registry
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@dxworks'
+
+      - name: Publish on NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Prepare Release Notes
+        run: touch ${{ github.workspace }}/releaseNotes/v${{ steps.semver_parser.outputs.semver }}.md
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v1
+        with:
+          name: Insider ${{ steps.semver_parser.outputs.semver }}
+          body_path: ${{ github.workspace }}/releaseNotes/v${{ steps.semver_parser.outputs.semver }}.md
+          body: ""
+          prerelease: false
+          draft: false
+          fail_on_unmatched_files: true
+          files: insider.zip

package/Dockerfile

@@ -0,0 +1,8 @@
+FROM openjdk:11
+WORKDIR /app
+ENV JAVA_TOOL_OPTIONS -agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n
+COPY ./build/libs/insider-*.jar /app/insider.jar
+COPY config/ /app/config/
+
+COPY bin/insider.sh /app/insider.sh
+RUN chmod +x /app/insider.sh

package/README.md

@@ -0,0 +1,89 @@
+# Insider
+
+Insider is a belt of tools built on the idea of searching regular expressions in code. Insider is able to detect code
+smells, the usage of external libraries and the topics that a software project approaches by only using Regex. This
+means that Insider does not use any type of parsing and is therefore language independent.
+
+## Installation
+
+### From Github
+
+To install Insider from Github, please download from the [latest release](https://github.com/dxworks/insider/releases)
+from Github, the `insider.zip` archive and unzip it to a specific location. The contents of this archive are:
+
+* `insider-*.jar` - the executable jar file
+* `insider.bat` - a batch script for executing Insider on Windows
+* `insider.sh` - a shell script for executing insider on Windows
+* `config` - a folder for configuration files, described more in the [Configuration Section](#Configuration)
+* `results` - a folder where Insider will output the results.
+
+### From Docker
+
+...
+
+### From Code
+
+Clone the repository from [here](https://github.com/dxworks/insider).
+
+Run `gradle clean build` to obtain an executable jar.
+
+## Configuration
+
+Edit the configuration file (*config/insider-conf.properties*), to **specify the root folder** of the project's sources.
+
+## Commands
+
+### Find Command
+
+* In order to find the occurrences of the libraries in the analyzed project. Use the following command (run Insider
+  using the **insider.bat** or **insider.sh** script):
+
+```
+insider.sh find config/libraries.json
+```
+
+* Detect Simple Code Smells. Use the following command (run Insider using the **insider.bat** or **insider.sh** script):
+
+```
+insider.sh find config/code_smells.json
+```
+
+* You can also run the *find* command with both files at once:
+
+```
+insider.sh find config/libraries.json config/code_smells.json
+```
+
+The commands will generate two *.json* files (**_PROJECT_ID-libraries.json_** and **_PROJECT_ID-code_smells.json_**) in
+the **results** folder.
+
+## Voyager Integration
+
+Insider is also a Voyager Instrument. To configure Insider from Voyager you can add the following fields in the `mission.yml` file:
+
+```yaml
+# A map of instrument names to commands and parameters.
+# When 'runsAll' is false the mission will run only the instruments
+# with the commands declared here, in this order.
+instruments:
+  insider:
+    # A map of parameter name to value
+    # Only add the parameters you want to override (the default values are written here)
+    parameters:
+      max-heap: 4g # will configure the maximum heap space the jvm process will get. For large process may be needed to be set to 16g or higher
+      findConfig: 'config/fingerprints/code_smells.json config/fingerprints/libraries.json' # a space separated list of insider fingerprints
+      inspectConfig: 'config/rules' # a space separated list of folders or Application Inspector specific rules, like the ones here: https://github.com/microsoft/ApplicationInspector/tree/main/AppInspector/rules/default
+
+# A map of environment variables, name to value, for voyager missions
+# overwrites the variables from global config, instrument and command
+# Only set the environment variables you need.
+environment:
+  INSIDER_LANGUAGES: 'java,c++,c#' # a comma separated list of the languages to analyse (just a sample example)
+  INSIDER_LINGUIST_FILE: "${instrument}/languages.yml" # a file containing languages to extension mappings according to [GitHub Linguist](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
+  INSIDER_DEPEXT_MAX_NAMESPACE_LENGTH: 200 # the maximum length of a namespace for DepExt analysis
+```
+
+## Acknowledgements
+
+The `inspect` command is inspired by the [Application Inspector](https://github.com/microsoft/ApplicationInspector)
+project created by Microsoft. Insider even uses the same input files as Application Inspector.

package/TODO.txt

@@ -0,0 +1,7 @@
+vezi sa nu existe un slash la inceputul fqn-urilor fisierelor
+
+la techFinder sa spui pe ce fisier lucreaza (poate fa-le in paralel)
+
+loguie ce comanda face tot timpul
+
+loguie la final ce output gaseste si unde.

package/bin/insider.bat

@@ -0,0 +1 @@
+java -Xmx4g -jar insider.jar %*

package/bin/insider.sh

@@ -0,0 +1 @@
+java -jar -Xmx4g insider.jar $@

package/build.gradle

@@ -0,0 +1,55 @@
+plugins {
+    id 'java'
+    id 'io.freefair.lombok' version '6.6'
+}
+
+group 'org.dxworks'
+version '2.6.0-SNAPSHOT'
+
+sourceCompatibility = 11
+
+repositories {
+    mavenCentral()
+    mavenLocal()
+    maven {
+        name 'ossrh'
+        url 'https://s01.oss.sonatype.org/content/repositories/snapshots'
+    }
+}
+
+dependencies {
+
+    //command line runner
+    implementation group: 'info.picocli', name: 'picocli', version: '4.0.0-alpha-2'
+
+    implementation group: 'me.tongfei', name: 'progressbar', version: '0.7.2'
+
+    //data format parsers
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.11.0.rc1'
+    implementation 'com.opencsv:opencsv:4.1'
+    implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.2.4'
+
+
+    implementation group: 'commons-io', name: 'commons-io', version: '2.6'
+    implementation 'commons-lang:commons-lang:2.6'
+    implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.1'
+    implementation 'org.apache.commons:commons-collections4:4.4'
+
+    implementation group: 'ch.qos.logback', name: 'logback-classic', version: '1.2.3'
+
+    implementation 'org.dxworks:dx-ignore:1.1.0-SNAPSHOT'
+    implementation 'org.dxworks:argumenthor:1.1.0-SNAPSHOT'
+    implementation 'org.dxworks:dx-linguist:1.0.0-SNAPSHOT'
+    testImplementation group: 'junit', name: 'junit', version: '4.12'
+}
+
+jar {
+    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+    manifest {
+        attributes "Main-Class": "org.dxworks.insider.Insider"
+    }
+
+    from {
+        configurations.compileClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+    }
+}

package/config/.ignore

@@ -0,0 +1,4 @@
+**/.idea/**
+**/.git/**
+**/*.iml
+**/node_modules/**

package/config/comments.json

@@ -0,0 +1,71 @@
+[
+  {
+    "languages": [
+      "c",
+      "cpp",
+      "csharp",
+      "coffeescript",
+      "fsharp",
+      "go",
+      "groovy",
+      "jade",
+      "oc",
+      "rust",
+      "swift",
+      "javascript",
+      "java",
+      "typescript",
+      "php"
+    ],
+    "inline": "//",
+    "preffix": "/*",
+    "suffix": "*/"
+  },
+  {
+    "languages": [
+      "perl",
+      "perl6",
+      "r",
+      "shellscript",
+      "ruby",
+      "yaml",
+      "powershell",
+      "python"
+    ],
+    "inline": "#"
+  },
+  {
+    "languages": [
+      "lua",
+      "sql"
+    ],
+    "inline": "--"
+  },
+  {
+    "languages": [
+      "clojure"
+    ],
+    "inline": ";;"
+  },
+  {
+    "languages": [
+      "vb"
+    ],
+    "inline": "'"
+  },
+  {
+    "languages": [
+      "COBOL"
+    ],
+    "inlinePatterns": [
+      {
+        "pattern": "^.{6}[*/](.*)$",
+        "modifiers": ["g", "m"]
+      },
+      {
+        "pattern": "(\\*>)(.*)$",
+        "modifiers": ["g", "m"]
+      }
+    ]
+  }
+]

package/config/fingerprints/_anomalies-full.json

@@ -0,0 +1,116 @@
+{
+  "useProjectPrefix": true,
+  "technologies": [
+    {
+      "category": "Excessive Complexity",
+      "name": "Autogenerated Javadoc",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "(?i)Auto-generated\\s+Javadoc"
+      ],
+      "wrapAsImports": false
+    },
+    {
+      "category": "Abnormal Hierarchy Relations",
+      "name": "Instanceof Abuser",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "instanceof"
+      ],
+      "wrapAsImports": false
+    },
+    {
+      "category": "Abnormal Hierarchy Relations",
+      "name": "Stub Implementer",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "(?i)Auto-generated method stub",
+        "\\{\\s*\\/\\/Overridden Notification Method\\s*\\}",
+        "\\{\\s*return null;\\s*\\}"
+      ],
+      "wrapAsImports": false
+    },
+    {
+      "category": "Traceability Issues",
+      "name": "Console Writing",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "System\\.out\\.print",
+        "System\\.err\\.print"
+      ],
+      "wrapAsImports": false
+    },
+    {
+      "category": "Traceability Issues",
+      "name": "Stacktrace Dump",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "printStackTrace\\("
+      ],
+      "wrapAsImports": false
+    },
+    {
+      "category": "Traceability Issues",
+      "name": "Catch Top-Level Exception",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "catch\\s*\\(\\s*Exception ",
+        "catch\\s*\\(\\s*Error ",
+        "catch\\s*\\(\\s*Throwable "
+      ],
+      "wrapAsImports": false
+    },
+    {
+      "category": "Unit Testing",
+      "name": "Unit Test Files",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "org.junit",
+        "junit.framework",
+        "org.hamcrest"
+      ],
+      "wrapAsImports": true
+    },
+    {
+      "category": "Hardly Portable Technologies",
+      "name": "Embedded SQL Queries",
+      "languages": [
+        "java"
+      ],
+      "extensions": [],
+      "fingerprints": [
+        "PreparedStatement",
+        "java.sql",
+        "javax.sql",
+        "oracle.jdbc",
+        "oracle.security.o3logon",
+        "oracle.sql",
+        "oracle.net",
+        "oracle.jpub",
+        "org.skife.jdbi"
+      ],
+      "wrapAsImports": true
+    }
+  ]
+}