Nonchalantly Performs Magic

    gemini-url-decorator

    1.0.1 • Public • Published

    gemini-url-decorator

    Build Status Coverage Status

    Plugin for gemini which is intended to change test urls in runtime. You can read more about plugins at documentation.

    Installation

    npm install gemini-url-decorator

    Usage

    Configuration

    • url (optional) Object - the list of url parameters, which will be added in each test url
      • query (optional) Object - the list of query parameters
        • queryParam (optional) Object - name of query parameter
          • value (optional) String - value of query parameter
          • concat (optional) Boolean - enable/disable concatenation; by default is true

    Examples

    Add plugin to your gemini config file:

    system:
      plugins:
        url-decorator: true

    To pass additional url parameters you can use environment variables, which should start with GEMINI_URL_ or specify them in the gemini config file.

    For example, you have the following test url: http://localhost/test/?name=bilbo and you want to add query parameter via environment variable:

    GEMINI_URL_QUERY_TEXT=ololo gemini test

    After that your test url will be changed to: http://localhost/test/?name=bilbo&text=ololo.

    The same thing you can do using gemini config file:

    url-decorator:
      url:
        query:
          text:
            value: ololo
          # or 
          text: ololo

    Note: environment variables have higher priority than config values.

    Concatenation of url parameters

    In previous example you have seen how add url parameters. Now we look how to concat and override url parameters.

    Suppose, you want to add query parameter name which is already presented in your test url: http://localhost/test/?name=bilbo and you don't want to override it:

    url-decorator:
      url:
        query:
          name:
            value: torin
            concat: true
          # or 
          name:
            value: torin
          # or 
          name: torin
     

    The result url will look like: http://localhost/test/?name=bilbo&name=torin. How you understand, the result will be the same if concat would be any value except false.

    Moreover for previous test url you can specify a set of values for one query parameter:

    url-decorator:
      url:
        query:
          name:
            value:
              - torin
              - gloin
          # or 
          name:
            - torin
            - gloin

    The result url will look like: http://localhost/test/?name=bilbo&name=torin&name=gloin

    If you want to override value of name query parameter:

    url-decorator:
      url:
        query:
          name:
            value: torin
            concat: false

    As a result url will look like: http://localhost/test/?name=torin.

    You can do the same thing via environment variables. In this case concat value will be used from config to the same url parameter:

    GEMINI_URL_QUERY_NAME=gloin gemini test

    The result url will look like: http://localhost/test/?name=gloin

    Install

    npm i gemini-url-decorator

    DownloadsWeekly Downloads

    0

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • dudagod