1019267 - Marionette-testing leaves untracked files after completion

Status: RESOLVED FIXED

(Testing :: Marionette Client and Harness, defect)

Description

[Shashank VRSN Sabniveesu]

Currently, marionette-testing leaves these files untracked in the local repository. They appear on issuing 'hg status'

    $ hg st

    ? testing/marionette/client/marionette/gecko.log
    ? testing/marionette/client/marionette_client.egg-info/PKG-INFO
    ? testing/marionette/client/marionette_client.egg-info/SOURCES.txt
    ? testing/marionette/client/marionette_client.egg-info/dependency_links.txt
    ? testing/marionette/client/marionette_client.egg-info/entry_points.txt
    ? testing/marionette/client/marionette_client.egg-info/not-zip-safe
    ? testing/marionette/client/marionette_client.egg-info/requires.txt
    ? testing/marionette/client/marionette_client.egg-info/top_level.txt
    ? testing/marionette/transport/marionette_transport.egg-info/PKG-INFO
    ? testing/marionette/transport/marionette_transport.egg-info/SOURCES.txt
    ? testing/marionette/transport/marionette_transport.egg-info/dependency_links.txt
    ? testing/marionette/transport/marionette_transport.egg-info/entry_points.txt
    ? testing/marionette/transport/marionette_transport.egg-info/not-zip-safe
    ? testing/marionette/transport/marionette_transport.egg-info/top_level.txt

These should --

* be removed after every completion of tests or
* added to '.hgignore'

Comment 1

[Shashank VRSN Sabniveesu]

Can you comment on this?

Comment 2

[Jonathan Griffin (:jgriffin)]

The .egg-info files are a side-effect of Python package installation; how did you invoke the Marionette tests?

I agree it would make sense to add these to .hgignore.

Comment 3

[Shashank VRSN Sabniveesu]

(In reply to Jonathan Griffin (:jgriffin) from comment #2)
> The .egg-info files are a side-effect of Python package installation;
Do you mean they are due to -
"sudo apt-get install python-setuptools" ? Don't see invoking apt-get creates any local files

> how did you invoke the Marionette tests?
python runtests.py --binary=../../../../obj-i686-pc-linux-gnu/dist/bin/firefox --type=browser tests/unit-tests.ini 

> 
> I agree it would make sense to add these to .hgignore.
If they are one time creations during installation-only as you say, let us contact those developers to remove these files after isntallation

Comment 4

[Jonathan Griffin (:jgriffin)]

The .egg-info files probably come from doing something like:

  python setup.py develop

in the marionette directory.  This is only one way to install Marionette; we could add this to .hgignore.

Comment 5

[Shashank VRSN Sabniveesu]

(In reply to Jonathan Griffin (:jgriffin) from comment #4)
> The .egg-info files probably come from doing something like:
> 
>   python setup.py develop
Right. I forgot to mention this step

> in the marionette directory.  This is only one way to install Marionette; we
> could add this to .hgignore.
Can't we modify 'script.py' itself to clear those .egg-info files? Is there any purpose in retaining them?

Comment 6

[Jonathan Griffin (:jgriffin)]

The .egg-info files are generally not needed after installation; if you'd like to submit a patch to clean them up in setup.py, we could test it to make sure it's completely harmless.

Comment 7

[Shashank VRSN Sabniveesu]

(In reply to Jonathan Griffin (:jgriffin) from comment #6)
> The .egg-info files are generally not needed after installation; if you'd
> like to submit a patch to clean them up in setup.py, we could test it to
> make sure it's completely harmless.

Would a regular delete file instruction with path for the .egg-info directory at the end of setup.py do?
Or does the execution move to a different file once it is done with setup.py in which case those other files might require .egg-info to finish the installatiotheron?

Comment 8

[Jonathan Griffin (:jgriffin)]

The .egg-info files are not needed after setup() completes, unless you're using them to e.g., post a package to PyPI.

If you do submit a patch to remove the .egg-info files, please don't do that unless the action passed to setup.py is 'install'.

Comment 9

[David Burns :automatedtester]

I can't seem to replicate this anymore so going to assume it is fixed.

Comment 10

[Henrik Skupin [:whimboo][⌚️UTC+1]]

That was fixed by Andreas along with his patch on bug 1153822 just 3 days ago.

Comment 11

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Moving bugs for Marionette client due to component changes.