Initial functionality #9

dav3r · 2022-03-10T14:35:56Z

🗣 Description

The PR provides the initial functionality of this project, a script that simplifies the process of opening sessions to AWS instances using SSM, either with or without SSH, and includes helpful tab autocompletion of various parameters on the command line.

💭 Motivation and context

There are two main benefits to using this tool:

The command to open a session is much simpler than without it.
There is no need to separately look up the ID of the AWS instance you want to connect to, since the tab completion in this tool does it for you.

If you need to connect to many different AWS instances across multiple AWS accounts via the CLI, this tool will save you a bunch of time.

Note that since this repository/module supports non-SSH connections, @felddy and I discussed the pros and cons of renaming it (and appropriately adjusting the argument names and related code), but we ultimately agreed that "awssh" could refer to opening any shell via AWS. Also, it seemed like extra work for minimal benefits.

🧪 Testing

I verified that the basic functionality all works as intended and all automated tests pass.

✅ Pre-approval checklist

This PR has an informative and human-readable title.
Changes are limited to a single goal - eschew scope creep!
All relevant type-of-change labels have been added.
I have read the CONTRIBUTING document.
These code changes follow cisagov code standards.
All relevant repo and/or project documentation has been updated
to reflect the changes in this PR.
Tests have been added and/or modified to cover the changes in this PR.
All new and existing tests pass.

✅ Post-merge checklist

Add a tag or create a release.

This is the first commit of a working utility. It still has a bunch of TODOs. - Functions need docs - Better README - Clean up logging. - Ton of linter errors - Many more

Renamed the competer tool so that bash would not offer it as a completion when typing awssh<tab>

@dav3r

This was requested by @dav3r It is a bit of a weird case, where the current word doesn't match any candidate.

Also, update keywords from skeleton template and delete unused package_data line

mcdonnnj

Strong work from all involved. I mostly have some housekeeping change requests.

src/awssh/__init__.py

README.md

src/awssh/autocompleter.py

setup.py

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

src/awssh/autocompleter.py

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

src/awssh/autocompleter.py

This is in line with our standard of only specifying a return code if there is an error. Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

This enables cleaner class initialization code. Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

jsf9k

Approval intensifies

mcdonnnj

Thanks for your continued work on getting this out the door! I had some mypy related items that I missed on my initial review I would like resolved.

setup.py

src/awssh/awssh.py

We override the default flags in order to exclude the --ignore-missing-imports flag. As a result of that, we add some additional dependencies needed to successfully do type-checking. Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

Since these packages are not required for the tool to function, they do not belong in the install_requires section. Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

mcdonnnj

Just one more mypy dependency but otherwise LGTM ✔ Thanks for your work getting this over the finish line 💪💪💪

setup.py

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

felddy and others added 30 commits July 13, 2021 14:01

Initial commit of working code

6542b34

This is the first commit of a working utility. It still has a bunch of TODOs. - Functions need docs - Better README - Clean up logging. - Ton of linter errors - Many more

Rename completer tool

a76c670

Renamed the competer tool so that bash would not offer it as a completion when typing awssh<tab>

Allow completion matches on instance name

2807eea

This was requested by @dav3r It is a bit of a weird case, where the current word doesn't match any candidate.

Add better suggestions for name completions

b741068

Simplify logic for instance name selection

4e7815a

Add support for AWSSH_USER env variable

b566467

Add profile filter environment variable

413e271

Document supported environment variables

8fd5c5f

Handle instances that do no have tags

bc3e92f

Add CodeQL shield and remove broken ones

f9f7f96

Rename project to awssh

16d87a7

Merge branch 'develop' of github.com:cisagov/ssm-ssh into first-commits

58e4f89

Rename files and references to match project

3a57e1e

Appease mypy

d8f41b9

Make subprocess helper function private

12f6015

Remove unsupported Python versions

bfe7386

Add missing docstrings and refactor types

85b6637

Normalize and correct quoting of numerics

6e99d90

Document subprocess security for bandit

cc40fdc

Merge branch 'develop' into first-commits

ecf2a9b

Cleanup from isort hook

c841c6d

Add --no-ssh flag to open an SSM shell session without using ssh

52e8516

Remove f-strings from logging messages

f3b9c99

Clean up usage text

163ae4f

Add typing libraries to satisfy mypy checks

19b7627

Ignore type checking for schema module and add an explanatory comment

5bd4c85

Add more details to README documentation

c05662f

Update old references to renamed module

1048916

Set correct python version requirement

3d60ded

Also, update keywords from skeleton template and delete unused package_data line

Explicitly call sys.exit after SchemaError

e2bd4ba

mcdonnnj requested changes Mar 11, 2022

View reviewed changes

dav3r and others added 8 commits March 11, 2022 15:32

Merge branch 'develop' into first-commits

5746cc4

Use standard project badging from skeleton

b9a4980

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Add a link to the bash home page

9afe658

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Add a more useful description in setup.py

a9b4cdf

Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

Remove unnecessary shebang line

bff2451

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Prefer [] to list()

bcce0d7

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Move comment closer to line it applies to

4774eea

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Specify encoding when opening file

86b2f9f

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

dav3r commented Mar 11, 2022

View reviewed changes

src/awssh/autocompleter.py Outdated Show resolved Hide resolved

Avoid redefining built-in filter() function

345b293

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

dav3r commented Mar 11, 2022

View reviewed changes

src/awssh/autocompleter.py Outdated Show resolved Hide resolved

dav3r and others added 4 commits March 11, 2022 16:12

Make main() return None

d0654de

This is in line with our standard of only specifying a return code if there is an error. Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Prefer console to bash formatting for examples

bd8fc15

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Close log file if it exists

c525d1f

Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

Make ParsedState a data class

971b187

This enables cleaner class initialization code. Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

dav3r requested review from mcdonnnj and jsf9k March 14, 2022 19:07

jsf9k approved these changes Mar 14, 2022

View reviewed changes

mcdonnnj requested changes Mar 14, 2022

View reviewed changes

setup.py Outdated Show resolved Hide resolved

src/awssh/awssh.py Show resolved Hide resolved

dav3r mentioned this pull request Mar 16, 2022

Remove --ignore-missing-imports flag from mypy pre-commit hook cisagov/skeleton-generic#103

Open

1 task

dav3r and others added 2 commits March 16, 2022 15:10

Move packages related to type-checking to extras_require["test"] section

3db8629

Since these packages are not required for the tool to function, they do not belong in the install_requires section. Co-Authored-By: Nick <mcdonnnj@users.noreply.github.com>

dav3r requested review from mcdonnnj and jsf9k March 16, 2022 21:16

jsf9k approved these changes Mar 17, 2022

View reviewed changes

mcdonnnj approved these changes Mar 24, 2022

View reviewed changes

setup.py Show resolved Hide resolved

Add types-setuptools for mypy

486c618

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

dav3r merged commit 0947c7c into develop Mar 24, 2022

dav3r deleted the first-commits branch March 24, 2022 13:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial functionality #9

Initial functionality #9

dav3r commented Mar 10, 2022 •

edited

mcdonnnj left a comment

jsf9k left a comment

mcdonnnj left a comment

mcdonnnj left a comment

Initial functionality #9

Initial functionality #9

Conversation

dav3r commented Mar 10, 2022 • edited

🗣 Description

💭 Motivation and context

🧪 Testing

✅ Pre-approval checklist

✅ Post-merge checklist

mcdonnnj left a comment

Choose a reason for hiding this comment

jsf9k left a comment

Choose a reason for hiding this comment

mcdonnnj left a comment

Choose a reason for hiding this comment

mcdonnnj left a comment

Choose a reason for hiding this comment

dav3r commented Mar 10, 2022 •

edited