Merge pull request #979 from StanfordVL/docker-fixes

Re-create dev docker image and remove requirements-dev.txt
StanfordVL · Oct 16, 2024 · f786978 · f786978
2 parents 255a4e4 + 1d780c9
commit f786978
Show file tree

Hide file tree

Showing 9 changed files with 72 additions and 67 deletions.
diff --git a/.github/workflows/build-push-containers.yml b/.github/workflows/build-push-containers.yml
@@ -77,6 +77,16 @@ jobs:
           tags: |
             type=ref,event=branch
             type=semver,pattern={{version}}
+      -
+        name: Metadata for dev Image
+        id: meta-dev
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            stanfordvl/omnigibson-dev
+          tags: |
+            type=ref,event=branch
+            type=semver,pattern={{version}}
       -
         name: Metadata for vscode Image
         id: meta-vscode
@@ -97,8 +107,22 @@ jobs:
           tags: ${{ steps.meta-prod.outputs.tags }}
           labels: ${{ steps.meta-prod.outputs.labels }}
           file: docker/prod.Dockerfile
-          cache-from: type=gha
-          cache-to: type=gha,mode=min
+          cache-from: type=registry,ref=stanfordvl/omnigibson:og-develop
+          cache-to: type=inline
+
+      -
+        name: Build and push dev image
+        id: build-dev
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          build-args: "DEV_MODE=1"
+          push: true
+          tags: ${{ steps.meta-dev.outputs.tags }}
+          labels: ${{ steps.meta-dev.outputs.labels }}
+          file: docker/prod.Dockerfile
+          cache-from: type=registry,ref=stanfordvl/omnigibson:og-develop  # OK to share cache here.
+          cache-to: type=inline
 
       - name: Update vscode image Dockerfile with prod image tag
         run: |
@@ -113,5 +137,5 @@ jobs:
           tags: ${{ steps.meta-vscode.outputs.tags }}
           labels: ${{ steps.meta-vscode.outputs.labels }}
           file: docker/vscode.Dockerfile
-          cache-from: type=gha
-          cache-to: type=gha,mode=min
+          cache-from: type=registry,ref=stanfordvl/omnigibson:og-develop  # OK to share cache here.
+          cache-to: type=inline
diff --git a/.github/workflows/examples-as-test.yml b/.github/workflows/examples-as-test.yml
@@ -25,20 +25,10 @@ jobs:
         with:
           submodules: true
           path: omnigibson-src
-
-      # These are temporarily disabled due to some errors they cause where some
-      # unknown important dependency has its version changed and Isaac Sim will
-      # no longer launch properly. The result is that if dependencies change,
-      # the tests will stop working. This is a temporary fix until we can figure
-      # out how to fix this issue.
-
-      # - name: Install dev requirements
-      #   working-directory: omnigibson-src
-      #   run: pip install -r requirements-dev.txt
-
-      # - name: Install
-      #   working-directory: omnigibson-src
-      #   run: pip install -e .
+
+      - name: Install
+        working-directory: omnigibson-src
+        run: pip install -e .[dev]
 
       - name: Generate example tests
         working-directory: omnigibson-src
@@ -84,13 +74,9 @@ jobs:
           submodules: true
           path: omnigibson-src
 
-      - name: Install dev requirements
-        working-directory: omnigibson-src
-        run: pip install -r requirements-dev.txt
-
       - name: Install
         working-directory: omnigibson-src
-        run: pip install -e .
+        run: pip install -e .[dev]
 
       - name: Run tests
         working-directory: omnigibson-src

diff --git a/.github/workflows/profiling.yml b/.github/workflows/profiling.yml
@@ -32,19 +32,9 @@ jobs:
       - name: Checkout source
         uses: actions/checkout@v3
 
-      # These are temporarily disabled due to some errors they cause where some
-      # unknown important dependency has its version changed and Isaac Sim will
-      # no longer launch properly. The result is that if dependencies change,
-      # the tests will stop working. This is a temporary fix until we can figure
-      # out how to fix this issue.
-
-      # - name: Install dev requirements
-      #   working-directory: omnigibson-src
-      #   run: pip install -r requirements-dev.txt
-
-      # - name: Install
-      #   working-directory: omnigibson-src
-      #   run: pip install -e .
+      - name: Install
+        working-directory: omnigibson-src
+        run: pip install -e .[dev]
 
       - name: Run performance benchmark
         run: bash scripts/profiling.sh

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -49,19 +49,9 @@ jobs:
           submodules: true
           path: omnigibson-src
 
-      # These are temporarily disabled due to some errors they cause where some
-      # unknown important dependency has its version changed and Isaac Sim will
-      # no longer launch properly. The result is that if dependencies change,
-      # the tests will stop working. This is a temporary fix until we can figure
-      # out how to fix this issue.
-
-      # - name: Install dev requirements
-      #   working-directory: omnigibson-src
-      #   run: pip install -r requirements-dev.txt
-
-      # - name: Install
-      #   working-directory: omnigibson-src
-      #   run: pip install -e .
+      - name: Install
+        working-directory: omnigibson-src
+        run: pip install -e .[dev]
 
       - name: Print env
         run: printenv

diff --git a/docker/build_docker.sh b/docker/build_docker.sh
@@ -7,6 +7,14 @@ docker build \
     -f docker/prod.Dockerfile \
     .
 
+# Pass the DEV_MODE=1 arg to the docker build command to build the development image
+docker build \
+    -t stanfordvl/omnigibson-dev:latest \
+    -t stanfordvl/omnigibson-dev:$(sed -ne "s/.*version= *['\"]\([^'\"]*\)['\"] *.*/\1/p" setup.py) \
+    -f docker/prod.Dockerfile \
+    --build-arg DEV_MODE=1 \
+    .
+
 docker build \
     -t stanfordvl/omnigibson-vscode:latest \
     -f docker/vscode.Dockerfile \

diff --git a/docker/gh-actions/Dockerfile b/docker/gh-actions/Dockerfile
@@ -1,4 +1,4 @@
-FROM stanfordvl/omnigibson:og-develop
+FROM stanfordvl/omnigibson-dev:og-develop
 
 ARG DUMB_INIT_VERSION="1.2.2"
 ARG GIT_CORE_PPA_KEY="A1715D88E1DF1F24"
@@ -99,7 +99,7 @@ RUN echo en_US.UTF-8 UTF-8 >> /etc/locale.gen \
 ENV AGENT_TOOLSDIRECTORY=/opt/hostedtoolcache
 RUN mkdir -p /opt/hostedtoolcache
 
-ARG GH_RUNNER_VERSION="2.311.0"
+ARG GH_RUNNER_VERSION="2.320.0"
 
 ARG TARGETPLATFORM
 

diff --git a/docker/prod.Dockerfile b/docker/prod.Dockerfile
@@ -67,8 +67,12 @@ WORKDIR /omnigibson-src
 
 SHELL ["micromamba", "run", "-n", "omnigibson", "/bin/bash", "--login", "-c"]
 
-# Install OmniGibson
-RUN micromamba run -n omnigibson pip install -e .
+# Optionally install OmniGibson (e.g. unless the DEV_MODE flag is set)
+ARG DEV_MODE
+ENV DEV_MODE=${DEV_MODE}
+RUN if [ "$DEV_MODE" != "1" ]; then \
+    micromamba run -n omnigibson pip install -e .[dev]; \
+    fi
 
-ENTRYPOINT ["micromamba", "run", "-n", "omnigibson"]
+    ENTRYPOINT ["micromamba", "run", "-n", "omnigibson"]
 CMD ["/bin/bash"]
diff --git a/requirements-dev.txt b/requirements-dev.txt
diff --git a/setup.py b/setup.py
@@ -48,7 +48,22 @@
         "graphviz~=0.20",
         "matplotlib>=3.0.0",
     ],
-    extras_require={},
+    extras_require={
+        "dev": [
+            "pytest>=6.2.3",
+            "pytest-cov>=3.0.0",
+            "pytest_rerunfailures",
+            "mkdocs",
+            "mkdocs-autorefs",
+            "mkdocs-gen-files",
+            "mkdocs-material",
+            "mkdocs-material-extensions",
+            "mkdocstrings[python]",
+            "mkdocs-section-index",
+            "mkdocs-literate-nav",
+            "telemoma~=0.1.2",
+        ]
+    },
     tests_require=[],
     python_requires=">=3",
     include_package_data=True,