apigeelint
Node module to lint and Apigee Edge bundle.
Last updated 7 months ago by apetrosian .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install apigeelint 
SYNC missed versions from official npm registry.

apigeelint

Codacy Badge

Static code analysis for Apigee proxy bundles to encourage API developers to use best practices and avoid anti-patterns.

This utility is intended to capture the best practices knowledge from across Apigee including our Global Support Center team, Customer Success, Engineering, and our product team in a tool that will help developers create more scalable, performant, and stable API bundles using the Apigee DSL.

Status

At this point we are focused on plugin execution and modelling the various lintable assets including Bundles, Proxies, Targets, Flows, Steps, and Policies.

Plugins that test these abstractions are being developed concurrently.

Reporters (the means to report out results), Ingesters (bundle loaders) are to be developed with Filesystem being the only supported means of loading a bundle and all reporting now going to console.

Installation

Install using npm

npm install -g apigeelint

Usage

Run it using

apigeelint -s sampleProxy/ -f table.js

where -s points to the apiProxy source directory and -f is the output formatter desired.

Possible formats are "json.js" (the default), "stylish.js", "compact.js", "codeframe.js", "html.js", "table.js", "unix.js", "visualstudio.js", "checkstyle.js", "jslint-xml.js", "junit.js" and "tap.js".

Does this tool just lint or does it also check style?

This tool does both traditional linting (looking for problematic patterns) and style checking (enforcement of conventions). You can use it for both.

Tests

The test directory includes scripts to exercise a subset of rules. Overall linting can be tested with:

apigeelint -s ./test/sampleProxy/24Solver/apiproxy/

This sample includes many bad practices and as such generates a bit of noise.

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Rules

The list of rules is a work in progress and expected to increase over time. As product features change, rules will change as well. Linting and reporting will fall into one of the following broad categories:

Linter Status Code Name Description
Bundle        
  :white_check_mark: BN001 Bundle folder structure correctness. Bundles have a clear structure.
  :white_check_mark: BN002 Extraneous files. Ensure each folder contains appropriate resources in the bundle.
  :white_check_mark: BN003 Cache Coherence A bundle that includes cache reads should include cache writes with the same keys.
  :white_check_mark: BN004 Unused variables. Within a bundle variables created should be used in conditions, resource callouts, or policies.
  :white_check_mark: BN005 Unattached policies. Unattached policies are dead code and should be removed from production bundles.
  :white_check_mark: BN006 Bundle size - policies. Large bundles are a symptom of poor design. A high number of policies is predictive of an oversized bundle.
  :white_check_mark: BN007 Bundle size - resource callouts. Large bundles are a symptom of poor design. A high number of resource callouts is indicative of underutilizing out of the box Apigee policies.
  :white_medium_square: BN008 IgnoreUnresolvedVariables and FaultRules Use of IgnoreUnresolvedVariables without the use of FaultRules may lead to unexpected errors.
  :white_check_mark: BN009 Statistics Collector - duplicate policies Warn on duplicate policies when no conditions are present or conditions are duplicates.
Proxy Definition        
  :white_medium_square: PD001 RouteRules to Targets RouteRules should map to defined Targets
  :white_check_mark: PD002 Unreachable Route Rules - defaults Only one RouteRule should be present without a condition
  :white_check_mark: PD003 Unreachable Route Rules RouteRule without a condition should be last.
Target Definition        
  :white_check_mark: TD001 Mgmt Server as Target Discourage calls to the Management Server from a Proxy via target.
  :white_medium_square: TD002 Use Target Servers Encourage the use of target servers
Flow        
  :white_check_mark: FL001 Unconditional Flows Only one unconditional flow will get executed. Error if more than one was detected.
Step        
  :white_check_mark: ST001 Empty Step Empty steps clutter the bundle.
Policy        
  :white_check_mark: PO001 JSON Threat Protection A check for a body element must be performed before policy execution.
  :white_check_mark: PO002 XML Threat Protection A check for a body element must be performed before policy execution.
  :white_check_mark: PO003 Extract Variables with JSONPayload A check for a body element must be performed before policy execution.
  :white_check_mark: PO004 Extract Variables with XMLPayload A check for a body element must be performed before policy execution.
  :white_check_mark: PO005 Extract Variables with FormParam A check for a body element must be performed before policy execution.
  :white_medium_square: PO006 Policy Naming Conventions - default name Policy names should not be default.
  :white_check_mark: PO007 Policy Naming Conventions - type indication It is recommended that the policy name include an indicator of the policy type.
  :white_check_mark: PO008 Policy Name Attribute Conventions It is recommended that the policy name attribute match the display name of the policy.
  :white_medium_square: PO009 Service Callout Target - Mgmt Server Targeting management server may result in higher than expected latency use with caution.
  :white_medium_square: PO010 Service Callout Target - Target Server Encourage use of target servers.
  :white_medium_square: PO011 Service Callout Target - Dynamic URLs Error on dynamic URLs in target server URL tag.
  :white_medium_square: PO012 Service Callout Target - Script Target Node JSHint, ESLint.
  :white_check_mark: PO013 Resource Call Out - Javascript JSHint, ESLint.
  :white_medium_square: PO014 Resource Call Out - Java PMD, Checkstyle.
  :white_medium_square: PO015 Resource Call Out - Python Pylint.
  :white_medium_square: PO016 Statistics Collector - duplicate variables Warn on duplicate variables.
  :white_medium_square: PO017 Misconfigured - FaultRules/Fault Rule in Policy FaultRules are configured in ProxyEndpoints and TargetEndpoints.
  :white_check_mark: PO018 Regex Lookahead/Lookbehind are Expensive - Threat Protection Policy Regular expressions that include lookahead or lookbehind perform slowly on large payloads and are typically not required.
  :white_check_mark: PO019 Reserved words as variables - ServiceCallout Request Using "request" as the name of a Request may cause unexpected side effects.
  :white_check_mark: PO020 Reserved words as variables - ServiceCallout Response Using "response" as the name of a Response may cause unexpected side effects.
  :white_medium_square: PO021 Statistics Collector - reserved variables Warn on insertion of duplicate variables.
  :white_check_mark: PO022 Nondistributed Quota When using nondistributed quota the number of allowed calls is influenced by the number of Message Processors (MPs) deployed. This may lead to higher than expected transactions for a given quota as MPs now autoscale.
  :white_check_mark: PO023 Quota Policy Reuse When the same Quota policy is used more than once you must ensure that the conditions of execution are mutually exclusive or that you intend for a call to count more than once per message processed.
  :white_check_mark: PO024 Cache Error Responses By default the ResponseCache policy will cache non 200 responses. Either create a condition or use policy configuration options to exclude non 200 responses.
FaultRules        
  :white_check_mark: FR001 No Condition on FaultRule It's not a best practice to have a FaultRule without an outer condition, which automatically makes the FaultRule true.
Conditional        
  :white_check_mark: CC001 Literals in Conditionals Warn on literals in any conditional statement.
  :white_medium_square: CC002 Null Blank Checks Blank checks should also check for null conditions. (to be reviewed)
  :white_check_mark: CC003 Long condition statement Conditions should not be long.
  :white_check_mark: CC004 Overly complex condition Condition complexity should be limited to fix number of variables and conjunctions.
  :white_check_mark: CC006 Detect logical absurdities Conditions should not have internal logic conflicts - warn when these are detected.

From an implementation perspective the focus is on plugin support and flexibility over performance. Compute is cheap.

Disclaimer

This is not an officially supported Google product.

Current Tags

  • 0.3.0                                ...           latest (7 months ago)

19 Versions

  • 0.3.0                                ...           7 months ago
  • 0.2.8                                ...           9 months ago
  • 0.2.7                                ...           9 months ago
  • 0.2.6                                ...           10 months ago
  • 0.2.5                                ...           a year ago
  • 0.2.4                                ...           2 years ago
  • 0.2.3                                ...           2 years ago
  • 0.2.2                                ...           2 years ago
  • 0.2.1                                ...           2 years ago
  • 0.2.0                                ...           2 years ago
  • 0.1.8                                ...           2 years ago
  • 0.1.7                                ...           2 years ago
  • 0.1.6                                ...           2 years ago
  • 0.1.5                                ...           2 years ago
  • 0.1.4                                ...           2 years ago
  • 0.1.3                                ...           2 years ago
  • 0.1.2                                ...           2 years ago
  • 0.1.1                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
Downloads
Today 0
This Week 20
This Month 20
Last Day 0
Last Week 3
Last Month 7
Dependencies (21)
Dev Dependencies (4)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |