-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Deprecate the 'vscode' tasks and create the 'devcontainer' ones * address * lint * Update tasks/vscode.py * docs * address
- Loading branch information
1 parent
23533d4
commit 06f114a
Showing
4 changed files
with
194 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| """ | ||
| vscode namespaced tags | ||
| Helpers for getting vscode set up nicely | ||
| """ | ||
| import json | ||
| import os | ||
| from collections import OrderedDict | ||
| from pathlib import Path | ||
|
|
||
| from invoke import task | ||
| from invoke.exceptions import Exit | ||
| from libs.common.color import color_message | ||
|
|
||
| from tasks.build_tags import build_tags, filter_incompatible_tags, get_build_tags, get_default_build_tags | ||
| from tasks.flavor import AgentFlavor | ||
|
|
||
| DEVCONTAINER_DIR = ".devcontainer" | ||
| DEVCONTAINER_FILE = "devcontainer.json" | ||
| DEVCONTAINER_NAME = "datadog_agent_devcontainer" | ||
|
|
||
|
|
||
| @task | ||
| def setup( | ||
| _, | ||
| target="agent", | ||
| build_include=None, | ||
| build_exclude=None, | ||
| flavor=AgentFlavor.base.name, | ||
| arch='x64', | ||
| image='', | ||
| ): | ||
| """ | ||
| Generate or Modify devcontainer settings file for this project. | ||
| """ | ||
| flavor = AgentFlavor[flavor] | ||
| if target not in build_tags[flavor]: | ||
| print("Must choose a valid target. Valid targets are: \n") | ||
| print(f'{", ".join(build_tags[flavor].keys())} \n') | ||
| return | ||
|
|
||
| build_include = ( | ||
| get_default_build_tags(build=target, arch=arch, flavor=flavor) | ||
| if build_include is None | ||
| else filter_incompatible_tags(build_include.split(","), arch=arch) | ||
| ) | ||
| build_exclude = [] if build_exclude is None else build_exclude.split(",") | ||
| use_tags = get_build_tags(build_include, build_exclude) | ||
|
|
||
| if not os.path.exists(DEVCONTAINER_DIR): | ||
| os.makedirs(DEVCONTAINER_DIR) | ||
|
|
||
| devcontainer = {} | ||
| fullpath = os.path.join(DEVCONTAINER_DIR, DEVCONTAINER_FILE) | ||
| if os.path.exists(fullpath): | ||
| with open(fullpath, "r") as sf: | ||
| devcontainer = json.load(sf, object_pairs_hook=OrderedDict) | ||
|
|
||
| local_build_tags = ",".join(use_tags) | ||
|
|
||
| devcontainer["name"] = "Datadog-Agent-DevEnv" | ||
| if image: | ||
| devcontainer["image"] = image | ||
| if devcontainer.get("build"): | ||
| del devcontainer["build"] | ||
| else: | ||
| devcontainer["build"] = { | ||
| "dockerfile": "Dockerfile", | ||
| "args": {}, | ||
| } | ||
| if devcontainer.get("image"): | ||
| del devcontainer["image"] | ||
| devcontainer["runArgs"] = [ | ||
| "--cap-add=SYS_PTRACE", | ||
| "--security-opt", | ||
| "seccomp=unconfined", | ||
| "--name", | ||
| "datadog_agent_devcontainer", | ||
| ] | ||
| devcontainer["remoteUser"] = "datadog" | ||
| devcontainer["mounts"] = ["source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind,consistency=cached"] | ||
| devcontainer["customizations"] = { | ||
| "vscode": { | ||
| "settings": { | ||
| "go.toolsManagement.checkForUpdates": "local", | ||
| "go.useLanguageServer": True, | ||
| "go.gopath": "/home/datadog/go", | ||
| "go.goroot": "/usr/local/go", | ||
| "go.buildTags": local_build_tags, | ||
| "go.testTags": local_build_tags, | ||
| "go.lintTool": "golangci-lint", | ||
| "go.lintOnSave": "file", | ||
| "go.lintFlags": [ | ||
| "--build-tags", | ||
| local_build_tags, | ||
| "--config", | ||
| "/workspaces/datadog-agent/.golangci.yml", | ||
| ], | ||
| "[go]": { | ||
| "editor.formatOnSave": True, | ||
| }, | ||
| "gopls": {"formatting.local": "github.com/DataDog/datadog-agent"}, | ||
| }, | ||
| "extensions": ["golang.Go"], | ||
| } | ||
| } | ||
| devcontainer[ | ||
| "postStartCommand" | ||
| ] = "git config --global --add safe.directory /workspaces/datadog-agent && invoke install-tools && invoke deps" | ||
|
|
||
| with open(fullpath, "w") as sf: | ||
| json.dump(devcontainer, sf, indent=4, sort_keys=False, separators=(',', ': ')) | ||
|
|
||
|
|
||
| @task | ||
| def start(ctx, path="."): | ||
| """ | ||
| Start the devcontainer | ||
| """ | ||
| if not file().exists(): | ||
| print(color_message("No devcontainer settings found. Run `invoke devcontainer.setup` first.", "red")) | ||
| raise Exit(code=1) | ||
|
|
||
| if not is_installed(ctx): | ||
| print(color_message("Devcontainer CLI is not installed. Run `invoke install-devcontainer-cli` first.", "red")) | ||
| raise Exit(code=1) | ||
|
|
||
| ctx.run(f"devcontainer up --workspace-folder {path}") | ||
|
|
||
|
|
||
| @task | ||
| def stop(ctx): | ||
| """ | ||
| Stop the running devcontainer | ||
| """ | ||
| if not file().exists(): | ||
| print(color_message("No devcontainer settings found. Run `inv devcontainer.setup` first and start it.", "red")) | ||
| raise Exit(code=1) | ||
|
|
||
| if not is_up(ctx): | ||
| print(color_message("Devcontainer is not running.", "red")) | ||
| raise Exit(code=1) | ||
|
|
||
| ctx.run(f"docker kill {DEVCONTAINER_NAME}") | ||
|
|
||
|
|
||
| @task | ||
| def restart(ctx, path="."): | ||
| """ | ||
| Restart the devcontainer | ||
| """ | ||
| ctx.run(f"docker rm -f {DEVCONTAINER_NAME}") | ||
| start(ctx, path) | ||
|
|
||
|
|
||
| def file() -> Path: | ||
| return Path(DEVCONTAINER_DIR) / DEVCONTAINER_FILE | ||
|
|
||
|
|
||
| def is_up(ctx) -> bool: | ||
| res = ctx.run("docker ps", hide=True, warn=True) | ||
| # TODO: it's fragile to just check for the container name, but it's the best we can do for now | ||
| return DEVCONTAINER_NAME in res.stdout | ||
|
|
||
|
|
||
| def is_installed(ctx) -> bool: | ||
| res = ctx.run("which devcontainer", hide=True, warn=True) | ||
| return res.ok |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters