mosesliao / fastlane-plugin-lizard Goto Github PK

View Code? Open in Web Editor NEW

27.0 6.0 13.0 80 KB

🦎Official fastlane plugin for lizard code complexity analytics 🦎

Home Page: http://www.lizard.ws/

License: MIT License

Ruby 98.79% Dockerfile 1.21%

fastlane-plugin fastlane lizard code-analysis code-quality code-complexity cyclomatic-complexity ios android mac

fastlane-plugin-lizard's Introduction

fastlane-plugin-lizard

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-lizard, add it to your project by running:

fastlane add_plugin lizard

About Lizard

Lizard is an extensible Cyclomatic Complexity Analyzer for many imperative programming languages including C/C++ (doesn't require all the header files or Java imports).

For more information check out the GitHub repository

Lizard Actions

Lizard has only one action so far

lizard(
  source_folder: 'foo',
  language: 'swift',
  export_type: 'csv',
  report_file: 'bar.csv'
)

Options

Multiple languages

language: 'swift,objectivec'

Multiple excludes

exclude: 'spec_helper.rb,fixtures/*'

XML reports

export_type: 'xml'

Sonar Swift Usage

In the default configuration, the Backelite sonar-swift plugin for SonarQube expects an xml report located at sonar-reports/lizard-report.xml:

lizard(source_folder: 'foo', export_type: 'xml', report_file: 'sonar-reports/lizard-report.xml')

The plugin doesn't create the directories specified in the report_file path, so they must exist or an error will occur.

Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out fastlane.tools.

fastlane-plugin-lizard's People

Contributors

Stargazers

Watchers

Forkers

mgrebenets friederbluemle team-supercharge exhorder atul9 kinwahlai cyupa unknoob tthbalazs gitter-badger limfinity aserdobintsev eaceto

fastlane-plugin-lizard's Issues

lizard-report.xml created as per lizard() is not parsing in sonarqube and not printing the code complexity stats.

i tried to transform xml to sonar_transform_xml but it failed. please help on this issue. its blocking our pipeline works

lizard(source_folder: "./Packages/Account/Sources", verbose: true, language: "swift", export_type: "xml", report_file: "sonar-reports/lizard-report.xml")

its creating an xml file with details but not parsing in sonarqube
@terryyin

New Image for social preview

Hi guys, I have a few images to put up for social preview of this plugin. Please give a vote by giving a 👍in the comments

Bundler dependency too strict

Bundler dependency < 2.0.0, >= 1.12.0 is too strict and causes issues with using bundler 2.0.0 and above.

Doesn't accept multi exclude path

When calling lizard from CLI we can specify as many --exclude paths as we need but astlane-plugin-lizard accepts only one.

I propose to change exclude parameter to accept an array of paths.

Lizard finished with errors (exit code: 0) (FastlaneCore::Interface::FastlaneError)

Hi, wanted to use the plugin today. Got the error bellow.

I am using fastlane 2.93.1
lizard (1.14.10)
Python 2.7.10 (default, Oct 6 2017, 22:29:07)
[GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.31)] on darwin
Type "help", "copyright", "credits" or "license" for more information.

my fastlane looks like this

lane :sonarscan do

  lizard(
  source_folder: 'XXXXX/Classes',
  language: 'swift,objectivec',
  export_type: 'xml',
  report_file: 'sonar-reports/lizard-report.xml'
)
  sonar(
    project_configuration_path: "../",
    sonar_login: "XXXXXXX",
    sonar_runner_args:"-Dsonar.host.url=https://XXXXXXXX"
  )
  end

DEBUG [2018-04-30 15:21:56.80]: All plugins are up to date
ERROR [2018-04-30 15:21:56.80]: fastlane finished with errors
DEBUG [2018-04-30 15:21:56.80]: All plugins are up to date
/Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane_core/lib/fastlane_core/ui/interface.rb:133:in `user_error!': [!] Lizard finished with errors (exit code: 0) (FastlaneCore::Interface::FastlaneError)
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane_core/lib/fastlane_core/ui/ui.rb:17:in `method_missing'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-plugin-lizard-1.1.1/lib/fastlane/plugin/lizard/actions/lizard_action.rb:68:in `handle_lizard_error'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-plugin-lizard-1.1.1/lib/fastlane/plugin/lizard/actions/lizard_action.rb:31:in `rescue in run'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-plugin-lizard-1.1.1/lib/fastlane/plugin/lizard/actions/lizard_action.rb:27:in `run'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:257:in `block (2 levels) in execute_action'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/actions/actions_helper.rb:50:in `execute_action'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:236:in `block in execute_action'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:231:in `chdir'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:231:in `execute_action'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:157:in `trigger_action_by_name'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/fast_file.rb:148:in `method_missing'
	from Fastfile:54:in `block (2 levels) in parsing_binding'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/lane.rb:33:in `call'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:49:in `block in execute'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:45:in `chdir'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/runner.rb:45:in `execute'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/lane_manager.rb:59:in `cruise_lane'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/command_line_handler.rb:36:in `handle'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/commands_generator.rb:107:in `block (2 levels) in run'
	from /Library/Ruby/Gems/2.3.0/gems/commander-fastlane-4.4.6/lib/commander/command.rb:178:in `call'
	from /Library/Ruby/Gems/2.3.0/gems/commander-fastlane-4.4.6/lib/commander/command.rb:153:in `run'
	from /Library/Ruby/Gems/2.3.0/gems/commander-fastlane-4.4.6/lib/commander/runner.rb:476:in `run_active_command'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane_core/lib/fastlane_core/ui/fastlane_runner.rb:75:in `run!'
	from /Library/Ruby/Gems/2.3.0/gems/commander-fastlane-4.4.6/lib/commander/delegates.rb:15:in `run!'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/commands_generator.rb:332:in `run'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/commands_generator.rb:41:in `start'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/fastlane/lib/fastlane/cli_tools_distributor.rb:108:in `take_off'
	from /Library/Ruby/Gems/2.3.0/gems/fastlane-2.93.1/bin/fastlane:20:in `<top (required)>'
	from /usr/local/bin/fastlane:22:in `load'
	from /usr/local/bin/fastlane:22:in `<main>'
matrixsmacdanil-wifi:preventivecare danila$

Lizard finished with errors (exit code: 0)

When I run my fastfile lane I get the following error when lizard is being executed after about 40 seconds.

[13:55:54]: --------------------
[13:55:54]: --- Step: lizard ---
[13:55:54]: --------------------
Shell command exited with exit status 1 instead of 0.
[13:56:37]: 
[13:56:37]: Lizard finished with exit code 0, which represents a failure.

It doens't give any more information than this unfortunately.

Contents of my lane:

lizard(
  language: "swift", 
  export_type: "xml", 
  report_file: "./fastlane/lizard-report.xml", 
  executable: "/Library/Python/3.7/site-packages/lizard.py"
)

What makes it strange is that when I run the following command directly in terminal it does finish without any errors and with a xml output.
python3 /Library/Python/3.7/site-packages/lizard.py ./ -l swift --xml

Any idea what is going wrong?

Getting 'Your lizard version is outdated' error although it isn't

Hello, I'm having some trouble adding lizard into my fastlane script

lane :metrics do
    scan(scheme: "Scheme", code_coverage: true, derived_data_path: "./DerivedData", output_directory: "./reports")
    slather(cobertura_xml: true, jenkins: true, scheme: "Scheme", build_directory: "./DerivedData", output_directory: "./reports", proj: "./Project.xcodeproj")
    lizard(source_folder: "./Sources", language: "swift", export_type: "xml", report_file: "report/lizard-report.xml", executable: "/Library/Python/2.7/site-packages")
    swiftlint(output_file: "./reports/swiftlint.txt", ignore_exit_status: true)
    sonar
  end

fastlane: 2.105.2
lizard: 1.15.6
python: 2.7.10

I'm getting an error: "Your lizard version is outdated, please upgrade to at least version 1.14.10 and start your lane again!", although lizard is 1.15.6 which is clearly newer than 1.14.10. Not sure where to go from here, would appreciate any help. Thank you.

Metric 'file_complexity' should not be computed by a Sensor

[35mjava.lang.UnsupportedOperationException: Metric 'file_complexity' should not be computed by a Sensor�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.sensor.DefaultSensorStorage.saveMeasure(DefaultSensorStorage.java:253)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.index.DefaultIndex.addMeasure(DefaultIndex.java:153)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.deprecated.DeprecatedSensorContext.saveMeasure(DeprecatedSensorContext.java:128)�[0m [14:08:18]: ▸ �[35mat org.sonar.plugins.objectivec.complexity.LizardMeasurePersistor.saveMeasures(LizardMeasurePersistor.java:78)�[0m [14:08:18]: ▸ �[35mat org.sonar.plugins.objectivec.complexity.LizardSensor.analyse(LizardSensor.java:75)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.phases.SensorsExecutor.executeSensor(SensorsExecutor.java:88)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.phases.SensorsExecutor.execute(SensorsExecutor.java:82)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.phases.SensorsExecutor.execute(SensorsExecutor.java:68)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.phases.AbstractPhaseExecutor.execute(AbstractPhaseExecutor.java:88)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.scan.ModuleScanContainer.doAfterStart(ModuleScanContainer.java:180)�[0m [14:08:18]: ▸ �[35mat org.sonar.core.platform.ComponentContainer.startComponents(ComponentContainer.java:135)�[0m [14:08:18]: ▸ �[35mat org.sonar.core.platform.ComponentContainer.execute(ComponentContainer.java:121)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.scan.ProjectScanContainer.scan(ProjectScanContainer.java:288)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.scan.ProjectScanContainer.scanRecursively(ProjectScanContainer.java:283)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.scan.ProjectScanContainer.doAfterStart(ProjectScanContainer.java:261)�[0m [14:08:18]: ▸ �[35mat org.sonar.core.platform.ComponentContainer.startComponents(ComponentContainer.java:135)�[0m [14:08:18]: ▸ �[35mat org.sonar.core.platform.ComponentContainer.execute(ComponentContainer.java:121)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.task.ScanTask.execute(ScanTask.java:48)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.task.TaskContainer.doAfterStart(TaskContainer.java:84)�[0m [14:08:18]: ▸ �[35mat org.sonar.core.platform.ComponentContainer.startComponents(ComponentContainer.java:135)�[0m [14:08:18]: ▸ �[35mat org.sonar.core.platform.ComponentContainer.execute(ComponentContainer.java:121)�[0m [14:08:18]: ▸ �[35mat org.sonar.scanner.bootstrap.GlobalContainer.executeTask(GlobalContainer.java:121)�[0m [14:08:18]: ▸ �[35mat org.sonar.batch.bootstrapper.Batch.doExecuteTask(Batch.java:116)�[0m [14:08:18]: ▸ �[35mat org.sonar.batch.bootstrapper.Batch.execute(Batch.java:71)�[0m [14:08:18]: ▸ �[35mat org.sonarsource.scanner.api.internal.batch.BatchIsolatedLauncher.execute(BatchIsolatedLauncher.java:46)�[0m [14:08:18]: ▸ �[35mat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)�[0m [14:08:18]: ▸ �[35mat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)�[0m [14:08:18]: ▸ �[35mat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)�[0m [14:08:18]: ▸ �[35mat java.lang.reflect.Method.invoke(Method.java:498)�[0m [14:08:18]: ▸ �[35mat org.sonarsource.scanner.api.internal.IsolatedLauncherProxy.invoke(IsolatedLauncherProxy.java:60)�[0m [14:08:18]: ▸ �[35mat com.sun.proxy.$Proxy0.execute(Unknown Source)�[0m [14:08:18]: ▸ �[35mat org.sonarsource.scanner.api.EmbeddedScanner.doExecute(EmbeddedScanner.java:171)�[0m [14:08:18]: ▸ �[35mat org.sonarsource.scanner.api.EmbeddedScanner.execute(EmbeddedScanner.java:128)�[0m [14:08:18]: ▸ �[35mat org.sonarsource.scanner.cli.Main.execute(Main.java:111)�[0m [14:08:18]: ▸ �[35mat org.sonarsource.scanner.cli.Main.execute(Main.java:75)�[0m [14:08:18]: ▸ �[35mat org.sonarsource.scanner.cli.Main.main(Main.java:61)�[0m

Rspec tests for fastlane-plugin-lizard

So far this plugin has no rspec test, because I am not sure what kind of test a lizard or a fastlane user will need in this plugin.

Let's contribute ideas what kind of tests this plugin needs, then we will look into the CI/CD needed to run the process

Lizard exclude parameter being generated incorrectly by the plugin

I tried to set a exclude parameter with multiple patterns but the plugin is incorrectly generating the command so lizard ignores the patterns.

Here's the plugin call on fastlane

lizard(
      source_folder: ".", 
      exclude: "./Folder1/Subfolder1/*, ./Folder2/*",
      language: "swift", 
      export_type: "xml", 
      report_file: "sonar-reports/lizard-report.xml"
    )

The command generated is:
lizard -l swift --xml -x ./Folder1/Subfolder1/* -x ./Folder2/* . > sonar-reports/lizard-report.xml

But according to lizard documentation it should be:
lizard -l swift --xml -x "./Folder1/Subfolder1/*" -x "./Folder2/*": . > sonar-reports/lizard-report.xml

Reference: https://github.com/terryyin/lizard/blob/master/README.rst
Don't forget to add "" around the pattern.