Adding python script to easily obtain key customer info

[sarahraza007]

Runs commands in command line, conducts string manipulation to obtain key pieces of infromation, and saves to results file

[anfelbar]

@sarahraza007 please update your branch to fix the CI errors. From your working branch, run git fetch and then git merge origin/main. You should push the update and that's all. We will then continue working on this branch, I have converted this PR to draft for now.

[anfelbar]

@sarahraza007 Thank you!
Now please, lets move the code to a subdirectory that does not exists yet so you need to create it (two directories actually). Lets put the script you made into scripts/customer-info/ directory. It may be the case we create more scripts to help us with other tasks.

[anfelbar]

Please, move the files you are working on to scripts/customer-info/, you need to create the customer-info folder inside the folder scripts and put your files there :)

[anfelbar]

@sarahraza007 just one final note before we consider merging this PR. Please add a readme.md file in the scripts/customer-info/ directory. In that file you write documentation about the script. I would expect something like

1. Goal: what do we want to do with the script? General view. Expected result.
2. How do we want to do it? By using aquery, cquery and so on.
3. Current implementation. Just saying what is the script currently doing.
4. How to execute? Show as well an output example.
5. ....

Add more content as needed.

[anfelbar]

Good job @sarahraza007 !
Let's continue with some modifications.

1. Adapt the generated file yaml with readable fields like total_actions: 47.
2. Lets show help for the user when he does not provide enough arguments.
   For instance we can

   iflen(sys.argv) <3:
   print("NICE PARAGRAPH EXPLAINING THE ARGUMENTS WE NEED BLABLABLA")

3. Lets add some nice prints to show progress and more. A few ideas (add whatever you see necessary)

   print("Analysing target ", target, file=sys.stderr)
   ...
   print("Extracting targets information", , file=sys.stderr)
   ...
   print("saving analysis file in path....", file=sys.stderr)

4. Lets provide a way to explore the repository instead of giving a target. So we could do something like
   1. List the directories in the provided repository path
   2. Apply analysis for //directory and save the result in an independent file
   3. Save global results (summation of individual results) in another file

Please, also update your branch with:

git fetch git merge origin/main

[vaibhav-shah]

Functionality and information wise, this looks great so far!!

There is one case I am curious about - do we need to account for build options that users might pass to the Bazel CLI? For example, I might run a build with certain configurations and flags: bazel build //this/is/an:example --config=remote --incompatible_strict_action_env ...

I'm thinking we can provide a list build_options that the end user would populate before running the script. This list would then be passed to bazel cquery when we call it (cqueryshould support build options). Let me know your thoughts.

[vaibhav-shah]

I'd be really curious to see what this section looks like when the script is ran in another repo; details like darwin_amd64 in Execution Platforms are very helpful but the Configurations section seems a bit redundant in this example.

[sarahraza007]

I ran it on the engflow directory and this is what it looked like

[lfpino]

Can we check this in?

[anfelbar]

Moving this to Ready for review.

[lfpino]

I've asked @vaibhav-shah to take over this and find a good place for this to live as a sales tool

[anfelbar]

Do we reached a decision on where to put this?