Hi folks, is this open source? Could you please clarify what license this is released under? https://docs.github.com/en/github/building-a-strong-community/adding-a-license-to-a-repository

I am currently trying to use this module, but I have an error:

Problems loading reference 'https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-tasks.json': Unable to load schema from 'https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-tasks.json': No content.

The quick traffic debug show that server return
"304 - not modified" on load request
Cache clearing dit not help

I see two non-exclusive solutions:

• make schema path configurable
• use 'do not cache' headers on request

Many proposed changes do require effective local testing and it would be very useful to publish the extension artifact on them so we can easily install it and test the proposed change locally.

Problem

Add task completion name to work with collection completions. Currently module name completion is supported. Installing a new collection from galaxy user would except to provide completion for collection name while fully qualified names for plugins.

Solution

Update ansible-language-server to parse collection name and provide as completion item in client reponse.

Alternatives

No response

Additional context

No response

Hi,

i hate to be that guy but this extension isn't working for me at all.
I have the suspicion that the fact that I'm using WSL isn't helping either.
When i'm running vscode inside the WSL environment via the "Remote" feature, nothing happens when i save the file.
When i'm running it "normally" on Windows it obviously complains that the path to ansible-lint is invalid because i only installed it inside WSL.

Is your feature request related to a problem? Please describe.
Not a problem but a lack of UX: you are asked to choose a vault id even if only one is configured

Describe the solution you'd like
Not to be asked if only one vault id is configured

Describe alternatives you've considered
.

Additional context
.

Problem

Currently execution environment is not supported with ansible-language-server

Solution

Add client options for EE and update server to provide diagnostics information with execution-environments.

Alternatives

No response

Additional context

No response

Hi, I recently installed the extension and so far it's exactly what I needed; thanks for your work!

I really think that the extension should register a dedicated channel to log its events. It would also help in solving errors (e.g. by logging the ansible-lint invocation output)

It currently only logs this message to the vscode extension host channel:

https://github.com/ansible-community/vscode-ansible/blob/103e7208d78b6ecaef205bf98d9c2c172d55f2ea/src/extension.ts#L12

It should be doable relatively easily by using this:

https://code.visualstudio.com/api/references/vscode-api#window.createOutputChannel

And using the resulting OutputChannel.appendLine(...) method.

I'd be really interested in helping directly but I have exactly zero experience in developing vscode extensions.

Currently this plugin expects you to have ansible yml files in the following directory structure:

      {
        "fileMatch": "requirements.yml",
        "url": "https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-requirements.json"
      },
      {
        "fileMatch": "meta/main.yml",
        "url": "https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-meta.json"
      },
      {
        "fileMatch": ["vars/*.yml", "defaults/*.yml", "host_vars/*.yml", "group_vars/*.yml"],
        "url": "https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-vars.json"
      },
      {
        "fileMatch": ["tasks/*.yml", "handlers/*.yml"],
        "url": "https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-tasks.json"
      },
      {
        "fileMatch": ["playbooks/*.yml", "playbooks/*.yaml"],
        "url": "https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-playbook.json"
      }

If you have your playbook in another folder, say ansible/main.yml it will not match. This should be worked around to implement a broader match for valid ansible yml files.

One major goal of this extension is to add support for Ansible while not affecting language support of other YAML files. Due to this it makes sense to integrate with https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml and avoid implementing features that can already be supported by it and a JSON/YAML schema.

Issue: !vault | results in unknown tag

Encrypting individual variables in an inventory results in schema errors. Relevant docs for ansible vault:

https://docs.ansible.com/ansible/latest/user_guide/vault.html#encrypting-individual-variables-with-ansible-vault

Here's an anonymized snippet from my ansible inventory:

snmp:
  addresses:
    - "10.44.16.10"
  rocommunity: !vault |
    $ANSIBLE_VAULT;1.1;AES256
    31353063366434366235343939393130626666383561336638613963633636393962656231646536
    3237316430363038303632383464653432336534666336340a333262653237396137623564343630
    38656561323031356265653964653238633636393832643062356338666538303431333337653033
    3836666439393132300a383633376465366130356237633439323639353335383338333465343935
    33663861333232663865316237656138373133393461333733313639383733391234

And screenshot from VS Code ansible extension showing issue (https://github.com/ansible-community/vscode-ansible):

i have opened a Folder containing a playbook in vscode.
inside a subfolder named group_vars i have all.yml containing some variables.

vscode-ansible complains about the format because it uses the "Ansible Playbook Schema" for some reason:

i saw you have set yamlValidation accordingly in your package.json so i don't know what is happening here.

Autocomplete is not working properly when I'm editing a tasks file within a role, I only get suggestions for generic task parameters:

It does work in a top-level playbook however:

To Reproduce
Create a new role and start editing a tasks file.

Expected behavior
I expect to get full autocomplete suggestions when editing the tasks file.

Platform:

• OS: macOS 11.4
• VSCode: Version: 1.58.1 Commit: 2aeda6b18e13c4f4f9edf6667158a6b8d408874
• Ansible Language Extension 0.4.5

Please see my comments here: #129 (comment)

This extension allows to configure the path to the ansible-lint executable, but this is not enough. ansible-lint calls the ansible executable and expects this to be on the global PATH:

https://github.com/ansible-community/ansible-lint/blob/57a6d5bd1cb5fb85fdda040d0165d8a75c8f43f1/src/ansiblelint/config.py#L146

The same is probably true for the execution of yamllint.

So, what's the point of configuring the full path to ansible-lint if ansible and yamllint are expected to be on the global PATH? Why not just make the same assumption for the ansible-lint executable?

Instead of (or in addition to) making ansible.validate.executablePath and ansible.vault.executablePath configurable, I think it would be better to have another setting to configure a custom PATH that is valid for the whole extension and is also used when ansible-lint calls ansible (as shown above).

This setting could be called something like ansible.path and should be configurable per-workspace and per-folder, so that is can be adjusted for local venv or conda-environments. The value of this setting should be used instead or (probably better) be prepended to the global PATH of the vscode process.

As described in #129 (comment), setting a custom PATH when calling ansible-lint fixes the issue where ansible and yamllint are not on the global PATH.

In README.md it says filepaths should follow the official Ansible code layout guidelines. Clicking on the link and this structure comes up:

collection/
├── docs/
├── galaxy.yml
├── meta/
│   └── runtime.yml
├── plugins/
│   ├── modules/
│   │   └── module1.py
│   ├── inventory/
│   └── .../
├── README.md
├── roles/
│   ├── role1/
│   ├── role2/
│   └── .../
├── playbooks/
│   ├── files/
│   ├── vars/
│   ├── templates/
│   └── tasks/
└── tests/

But this does not work because package.json defines other paths.

Solution is to change package.json or suggest another file structure that matches paths defined in package.json

Describe the bug

After the last issue(s) within a .yml file reported by ansible-lint are fixed and the file saved, the issue(s) still gets shown inside the editor as well as the problems list, until the the file gets closed.

To Reproduce

Steps to reproduce the behavior:

1. Open a .yml file with one or more issues reported by ansible-lint
2. Fix all the issues and save the file
3. See the issues fixed in step 2 still present in the problems list of VSCode as well as in the editor
4. Close the file. Watch issues disappearing from the problem list

Example playbook for testing

- hosts: localhost
  vars: 
    testvar: "hello"
  tasks:
    - name: "test one {{testvar}}"
      debug:
        msg: "this is a test"

Expected behavior

The issues should not be shown any longer after the issues get fixed and the file gets saved, without having to close the file.

Platform:

tested on Fedora Linux and Windows 10

test system 1: Windows

Version: 1.56.0 (system setup)
Commit: cfa2e218100323074ac1948c885448fdf4de2a7f
Date: 2021-05-04T22:09:06.405Z
Electron: 12.0.4
Chrome: 89.0.4389.114
Node.js: 14.16.0
V8: 8.9.255.24-electron.0
OS: Windows_NT x64 10.0.19042

remote ssh is used to connect to a Debian 10 system
ansible-lint 5.0.8 using ansible 2.10.9 on the remote system

test system 2: Fedora

Version: 1.56.0
Commit: cfa2e218100323074ac1948c885448fdf4de2a7f
Date: 2021-05-04T21:58:14.757Z
Electron: 12.0.4
Chrome: 89.0.4389.114
Node.js: 14.16.0
V8: 8.9.255.24-electron.0
OS: Linux x64 5.11.18-300.fc34.x86_64

working on local files
ansible-lint 5.0.8 using ansible 2.10.9

Both test systems show the same behavior.

Additional context

When fixing the issues one by one and saving in between, the fixed issues get removed from the problem list as excepted. This only happens if there are no further issues found in the file.

The README states:

Display violations identified by ansible-lint, ansible own syntax check and yamllint inside problems tab.

The VSCode extension description states:

Ansible YAML schema verification, auto-complete, highlight problems reported by ansible-lint or yamllint and vault encryption and decryption.

But I cannot find any support for yamllint. In fact, when I search this repo for the word yamllint, the only matches are in text files.

Is this feature yet to come?

Edit: I know this sounds like a "feature request", but I've posted this as a "bug" because the current project descriptions advertise a feature that may not be there. In this case, I think this is a "bug" in the descriptions.

Describe the bug

This screenshot should demonstrates all the problem. It can be seen that the error report from VSCode cannot be correlated with the ansible-lint output at all.

The output should be:

parser-error: conflicting action statements: set_fact, dmmy
tasks/iptables.yml:2

yaml: too few spaces before comment (comments)
tasks/iptables.yml:88

yaml: too few spaces before comment (comments)
tasks/iptables.yml:89

but the error list is empty

Expected Behavior

VSCode plugin should use ansible-lint output

Current Behavior

It does not

Steps to Reproduce

1. git checkout https://github.com/kyl191/ansible-role-openvpn
2. open it with VSCode/ ansible plugin
3. add a random non-existing field to any task
4. save and observe both outputs

Environment

• Windows
• Mac
• Linux
• other (please specify)

ansible-vault supports executing programs, passing them --vault-id $vault_id. I see 2 ways this could be solved:

1. user interaction required: ask the user for the vault-id string in a popup (user enters vault-name@$whatever)
   • if $whatever is prompt, prompt for the password interactively
   • if $whatever isn't prompt, use it as is
2. no user interaction required: let the user configure the right part of the vault-id (be it a file or a password client) and try to detect the vault name from the file, construct the vault-id based on that, if it doesn't work, fall back to 1.

To provide entry for running playbooks and drop-down option can be supported to trigger either ansible-playbook or anisble-navigator in the terminal from IDE browser window.
In the dropdown menu add ansible-playbook and ansible-navigator options and trigger the run for playbook within the terminal

As ansible-lint have very special requirements for running, we need to be sure that we run ansible-lint --version and report any potential error in a visible way in the UI.

This should make it easier for users to debug broken or incomplete installs of ansible-lint tool.

Related: ansible/ansible-lint#1507

I am looking for others to join my effort of building a vscode extension for Ansible content creators. The project is in planning phase and installing the extension does not enable any features yet.

I would not have started yet-another-extension endeavor unless I would have found one to contribute to. It would worth mentioning existing related extensions:

• vscode-yaml extension provides schema verifications for YAML in a generic way. We are going to rely on it in order to enable Ansible schema, this extension can be seen as a dependency.
• ansible (ms) is an old Ansible extension developer by Microsoft China team which is currently unmaintained and which is not compatible with other YAML extensions, making it pretty much useful in practice.

As my JavaScript/TypeScript skills are not listed on my resume, I would likely progress very slow on this task and I will likely need help, especially for building the initial version. I am sure maintaining it will be much easier after we get the basics done.

If you want to help or know someone that could, please post a message. Thanks!

Describe the bug
When something is define as boolean in the schema, like ignore_errors when the value is set by a variable, vscode show an error telling Incorrect type. Expected "boolean".yaml-schema: BeremothTaskModel, even with the filter bool to force the type of the variable.

To Reproduce
Create a task like:

- name: "Demo error"
  fail:
    msg: fail except in check mode
  ignore_errors: "{{ ansible_check_mode | bool }}"

Expected behavior
No error about the type, at least when the type is forced (if | bool is specified this trigger a warning in the default configuration of ansible-lint, not without, so it'll be better if this isn't needed).

Platform:
Be sure vscode and extension are the latest versions and report here the
operating system you used. If you used remote-ssh or WSL. Please check if the
bug can be reproduced on Linux or MacOS.

• OS: Archlinux

The codeclimate output format is JSON and includes information that is not part of the brief pep8 format, like the multiline description of the error, which sometimes contains critical information about how to fix it.

We only need to swap our parser and call the linter with -f codeclimate instead of -p.

As the title probably needs not more explanation, I should mention that there are already 4 extensions on vscode marketplace related to vault editing. Looking at them I noticed a pattern where almost each of them seems to be a fork of a previous one. I suspect what caused it is that original creator lost interest in maintaining it.

Instead of cluttering the marketplace with yet another extension that aims to address the same issue, I am inclined to see if one of the authors of these extensions is willing to join efforts and transition this feature into our extension, so we can have less extensions but better maintained.

Identified extensions:

• https://marketplace.visualstudio.com/items?itemName=flaunay.ansible-vault&ssr=false#overview by @FlorianLaunay with last release on 2020.12.19
• https://marketplace.visualstudio.com/items?itemName=wolfmah.ansible-vault-inline by @wolfmah with last release on 2020.07.13
• https://marketplace.visualstudio.com/items?itemName=spinosae.ansible-vault by @spinosae with last release on 2020.06.03
• https://marketplace.visualstudio.com/items?itemName=dhoeric.ansible-vault by @dhoeric with last release on 2018.04.30

Vaulting use-cases

There are lots of way of working with secrets in Ansible and we will not be able to cover all from start, still we should document each one we identify and mention if they are supported or not, also allowing us to create tests for them later.

• single vault defined inside ansible.cfg: vault_identity_list = .pass or alternatives that can use names like [email protected] or [email protected]. Ansible encrypts and decrypts files without any prompts in this case, it does not expect passsing a vault id.
• multiple vaults defined inside ansible.cfg: vault_identity_list = [email protected] [email protected]. Ansible will try to guess decryption key to use if the encrypted text does not mention the name. Still encrypting requires mentioning the vault id.
• no vault_identity_list defined but ansible_password_file is defined, which points to the file with the secret.
• vault files that are executable ... (TBD)

Describe the bug

The top element in the inventory is highlighted with an error

To Reproduce
Steps to reproduce the behavior:

1. Create an inventory.yml in root directory
2. Fill inventory and open it
3. See this error at the top element:

A playbook must be a list of plays, got a <class 'ansible.parsing.yaml.objects.AnsibleMapping'> instead

Expected behavior
Inventories should not be treat as playbooks.

Platform:

VS Code: 1.56.2
Ansible Language Extension: v0.4.5
OS: macOS Big Sur 11.4
Ansible: 2.11.0

An example:

https://github.com/ansible-community/vscode-ansible/blob/5a2954607e1dc21b2de48d2633c13424c3acf0d0/package.json#L153-L159

Currently, it seems to be selectively set to include .yaml files into file matches throughout the file as opposed to only including .yml files. Considering .yaml is the actual official YAML file extension it might be an idea to include both extensions in every file match.

As we now have vaulting support for full lines, it would be very useful to allow decryption and encryption of inline strings too.

There is an already existing extension that does this at Vaulty (marketplace) - Vaulty (github) but I did not test it myself yet.

Still, I am sure it would be a good source of inspiration, maybe its author @codeflows would be interested into joining us?

Basically this task is about refactoring this extension to make use of https://github.com/ansible/ansible-language-server instead of YAML/JSON schema.

Checklist for releasing the rewritten version

• playbooks/tasks/vars/requirements/molecule files are still recognized and basic syntax errors recognized
• ansible-lint is working (at least when installed in path)
• can coexist with Red Hat YAML extension, in fact we can even keep the current dependency on it as it does provide support for schemas that we are unlikely to do ourselves (zuul, molecule, ansible-lint config).

@tomaciazek will have the pleasure to lead that purge ;)

Hi !

I use code-server in offline env.
I've installted this extension to write ansible config files.
But vscode tells me that he cannot hit for example : https://raw.githubusercontent.com/ansible-community/schemas/main/f/ansible-meta.json

Is exists a solution to bypass this or package this ?

Thanks !

Hi guys,

I am now using your plugin in version 0.3.0 and I really thanks you.
I just discovered an issue when there are a lint warning/error in a file that is included with include_tasks.

Let's see the main.yml file :

---
- name: Pre-processing checks
  include_tasks: pre-check.yml

Now, here is the pre-check.yml that has an indentation lint error on the last line, to trigger the lint message in the console :

- name: pre-check| clients list is empty
  fail:
    msg: "clients list is empty, please check configuration..."
  tags:
  - generate-rules

Ok so, let's see what the linter says :

Regarding the error message, it seems that there is something bad on line 5 within main.yml. Actually, the error message is into the pre-check.yml included file.

Thanks guys !

Describe the bug
After installing this extension, I get "problems" reported about YAML files, but they reference files with a weirdly relative link that make them not clickable.

To Reproduce
Steps to reproduce the behavior:

1. Install the extension
2. open an editor with YAML files that include syntax errors
3. look at the "problems" pane
4. file links are relative (with bad reference) and not absolute

For example, I get links like home/jlecour/ansible/playbook.yml instead of /home/jlecour/ansible/playbook.yml.

Expected behavior
File links should be clickable.

Version: 1.56.0
Commit: cfa2e218100323074ac1948c885448fdf4de2a7f
Date: 2021-05-04T21:58:14.757Z
Electron: 12.0.4
Chrome: 89.0.4389.114
Node.js: 14.16.0
V8: 8.9.255.24-electron.0
OS: Linux x64 4.19.0-16-amd64

Describe the bug

For example, there is a tree like this:

infra
├── README.md
├── ansible
│   ├── ansible.cfg
│   ├── group_vars
│   ├── .vault
│   ├── inventory.ini
│   └── playbooks
└── infra.code-workspace

# ansible.cfg
[defaults]
inventory=inventory.ini
[email protected]

If the ansible directory is in a subdirectory of project, vscode-ansible simply doesn't see it. As a result, the extension.ansible.vault command doesn't work, because it can't find the vault_identity_list setting.
If you run vscode from the subdirectory ansible, it works fine.

Maybe a feature should be added to specify the path to ansible.cfg and the extension.ansible.vault function will work relative to that path, or something like that. It's not really convenient to have to run an instance of vscode separately in the ansible directory in a large project to make encryption/decryption work on the fly.

In order to ease development and maintenance of this extensions we need to automate the packaging and publishing, making easy to make a new release just by using the release github feature.

• discover if there is an already existing action we can reuse (considering openvsx store too)
• action to package
• fail if current version from package.json was already release (tag existing or already uploaded)
• add PAT tokens
• publish on tags

Describe the bug
Well i dont know if its a bug but i followed the guide to install lint but still getting error when typing in the path of ansible-lint in config file

ansible-lint is installed in my /.local/bin/ansible-lint
PATH is also correct as i can execute the ansible-lint from anywhere
what else can be wrong ?

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Platform:

im running WIndows 10 with WSL2 and Ubuntu 20.04

Additional context
Add any other context about the problem here.

Problem

Currently execution environment is not supported with ansible-langauge-server

Solution

Update ansible-langauge-server to read client options releated to EE and support mounting and parsing Ansible doc files within EE to provide auto-completions

Alternatives

No response

Additional context

No response

Describe the bug
Vscode installed ansible language, unable to complete automatically

I do all my work on a remote linux server that has ansible-lint installed and running, but the extension will only look for it on my local windows box. Would it be possible to have it run remotely instead?

Is your feature request related to a problem? Please describe.

No tests.

Describe the solution you'd like

Tests must exist.

Describe alternatives you've considered

Giving up on quality.

Additional context

There's not many good examples of writing integration tests for VS Code extensions so here's some pointers I've found:

• https://developers.redhat.com/blog/2019/11/18/new-tools-for-automating-end-to-end-tests-for-vs-code-extensions
• https://github.com/redhat-developer/vscode-extension-tester/wiki
• https://github.com/redhat-developer/vscode-extension-tester
• https://vscode.rocks/testing/
• https://github.com/mlewand-org/vscode-test-content
• https://viatsko.github.io/awesome-vscode/#resources-for-extension-developers

Extension code should detect absence of ansible-lint executable and to prompt user to install the missing dependency.

I am not sure exactly how to implement it so, if someone can point to a similar example where is this is done, it would be awesome, or even better make a pull-request ;)

I have several tasks showing as needing to be named even thought they are named. If there is a way t surpress this warning, that would be great.

VS Code: 1.55.2
OS: Fedora 33
Ansible Language: v0.3.1

We need to display rule violations reported by ansible-lint inside the "problems" panel.

Things to consider:

• Running ansible-lint on single files is unreliable because it needs to look at the entire repository in order to detect which files are Ansible owned or not and even after doing so, they cannot be parsed in isolation (content of one file may produce an error in another file).
• We should try to avoid adding our own language server, we should make use of YAML.
• Finding a sample code that produces these problems could prove very useful

This extension is spawning tons of Python processes by running ansible-lint on all yaml files in all projects, including kubernetes manifests, etc. Results in huge CPU usage and high load. Found by running pgrep -fl Python after opening some k8s project.

Fixed for now by "ansible.validate.enable": false in settings.json.

Could it be configured to run lint only on 'ansible' files and not on all yaml?

I've noticed that extension is not "defining" 'ansbile' language in package.json, as in now deprecated vscoss.vscode-ansible extension but rather extending 'YAML' language, might that be root of this issue? Or it's just some misconfiguration on my system?

I'm happy to provide any additional info if needed.

VSCode: 1.55.0
zbr.vscode-ansible: v0.3.0
OS: MacOS 11.2.3

I used to use https://github.com/github.com/VSChina/vscode-ansible but that was deprecated.

I don't understand which is the recommended alternative - https://github.com/ansible-community/vscode-ansible (this one) or https://github.com/redhat-developer/vscode-yaml ?

And how do they differ?

Hi,

Here is my setup :

Version: 1.56.0
Commit: cfa2e218100323074ac1948c885448fdf4de2a7f
Date: 2021-05-04T21:58:14.757Z
Electron: 12.0.4
Chrome: 89.0.4389.114
Node.js: 14.16.0
V8: 8.9.255.24-electron.0
OS: Linux x64 4.19.0-16-amd64

I've just installed and enabled the extension (and event restarted VS Code), but the extension seems to remain inactive.
My playbooks/roles/… are still treated as YAML and Ansible is not in the list of possible languages.

Did I miss something?

While I developed this extension I do think it would be much better to publish it from either already existing Red Hat publisher or by creating a new Ansible, or Ansible Community publisher, one where @gundalow will also be fallback admin.

I am personally inclined to find the Red Hat publisher better because it would send a very good positive message about Red Hat contributions in general.

In fact, I would not even mind to transfer the github repository to @redhat-developer github organization if that is required.

My personal take is is may be better to keep it under @ansible-community because here are all the Ansible specific knowledge is involved and I expect that most contributors are likely to know more about Ansible than about JavaScript.

Obviously that we first need to find-out if Red Hat folks are going to welcome us.

Problem

Currently sub-option completion is not supported for tasks. Add sub-option completions support for tasks

Solution

Update ansible-language-sever documentation parsing login to parse sub-options

Alternatives

No response

Additional context

No response

Problem

For diagnostic messages if ansible-lint is not installed, provide diagnostics information by running ansible syntax check command.

Solution

Update ansible-language-sever to check if ansible-lint is installed or not. If not installed provide info message and fallback to ansible syntax check command.

Alternatives

No response

Additional context

No response