chore: create alias to source sky env in dev mode

[sachiniyer]

Added a small change to the template to create an alias for sourcing the python env. Addressing #4453 as a good first issue.

I ran the smoke tests, as well as verified that the alias existed when I created a job.

Tested (run the relevant ones):

• [ x] Code formatting: bash format.sh
• Any manual or new tests for this PR (please specify below) - None
• All smoke tests: pytest tests/test_smoke.py
• [ x] Relevant individual smoke tests: pytest tests/test_smoke.py::test_job_and_serve
• Backward compatibility tests: conda deactivate; bash -i tests/backward_compatibility_tests.sh

[romilbhardwaj]

Welcome to the SkyPilot community @sachiniyer! Thanks for this PR - left a minor comment.

[romilbhardwaj]

Can we reuse the is_dev conditional check above and wrap it into the same block?

Suggested change

	echo 'export SKYPILOT_DEV=1' >> ~/.bashrc
	{% endif %}
	{% if controller_envs.get("SKYPILOT_DEV") %}
	type sky-env > /dev/null 2>&1 || echo 'alias sky-env="{{ sky_activate_python_env }}"' >> ~/.bashrc
	{% endif %}
	echo 'export SKYPILOT_DEV=1' >> ~/.bashrc
	type sky-env > /dev/null 2>&1 || echo 'alias sky-env="{{ sky_activate_python_env }}"' >> ~/.bashrc
	{% endif %}

[romilbhardwaj]

Also, IIUC type checks symbols in the active shell. While it will work here, do you think something like this would be a more robust check:

  if ! grep -q "alias sky-env=" ~/.bashrc; then
    echo 'alias sky-env="{{ sky_activate_python_env }}"' >> ~/.bashrc
  fi

[cg505]

+1 to the grep solution, especially since I don't think it's guaranteed that the commands here are running in bash (could be some other sh like dash)

[sachiniyer]

Both suggestions make sense. Let me try again!

[sachiniyer]

Okay, so I was able to get the grep statement to work.

However, I am not able to figure out how the other dev statement ({% if is_dev %}) works. I am also not seeing 'export SKYPILOT_DEV=1' in .bashrc when I run the smoke tests or when I create a job manually (with SKYPILOT_DEV=1 set in my local shell)

I am also not seeing is_dev in the vars_to_fill map here. Not sure if there is something I am missing.

I also know that the controller envs are being set into the environment through this statement

envs:
{%- for env_name, env_value in controller_envs.items() %}
  {{env_name}}: {{env_value}}
{%- endfor %}

[cg505]

Wow, yeah, that's apparently been broken for more than a year. #2458 removed is_dev but apparently didn't remove this use. Good catch!
Could you move the export SKYPILOT_DEV=1 into your new conditional, delete the old one, and add a similar grep check? e.g.

grep -q "export SKYPILOT_DEV=" ~/.bashrc || echo 'export SKYPILOT_DEV=1' >> ~/.bashrc

[sachiniyer]

Sorry for the wait (work taking up a bit of my time). I've made the changes and ran a quick sanity check - seems to be good.

I am realizing it would be good to refactor this to a list of aliases outside of the jinja template, but I'll leave that for a future PR.

[romilbhardwaj]

Thanks @sachiniyer! Left a comment on correctness.

[romilbhardwaj]

May need to update this if conditional to check the actual value of SKYPILOT_DEV.

We set this key as:

    env_vars: Dict[str, str] = {
        env.env_key: str(int(env.get())) for env in env_options.Options
    }

the str type cast will always return a true here. To validate, I ran export SKYPILOT_DEBUG=0; sky jobs launch -- echo hi and my controller indeed had SKYPILOT_DEV=1.

[sachiniyer]

ahh, definitely missed that (and my bad, I should have checked the negative case).

I'll do a string match against the value, and perform two tests (and post results)

1. Positive case with SKYPILOT_DEBUG=1
2. Negative case with SKYPILOT_DEBUG=0

[sachiniyer]

Positive Case

(skypilot) 👋🌍 finished/skypilot git:(master) ❱❱ export SKYPILOT_DEV=1
(skypilot) 👋🌍 finished/skypilot git:(master) ❱❱ pyenv exec sky jobs launch -n test-1 --cloud aws examples/managed_job.yaml -y -d

(base) ubuntu@ip-172-31-28-229:~$ echo $SKYPILOT_DEV
1
(base) ubuntu@ip-172-31-28-229:~$

Negative Case

(skypilot) 👋🌍 finished/skypilot git:(master) ❱❱ export SKYPILOT_DEV=0
(skypilot) 👋🌍 finished/skypilot git:(master) ❱❱ pyenv exec sky jobs launch -n test-1 --cloud aws examples/managed_job.yaml -y -d

(base) ubuntu@ip-172-31-28-216:~$ echo $SKYPILOT_DEV

(base) ubuntu@ip-172-31-28-216:~$

[romilbhardwaj]

Thanks @sachiniyer! LGTM.

[romilbhardwaj]

nit: we generally use single quotes for strs in our codebase