Merge pull request #120 from PLUS-POSTECH/update-command

Update command

Author: qwaz

README.md

@@ -18,27 +18,28 @@
   * [Stopping problems](#stopping-problems)
   * [Removing problem images](#removing-problem-images)
   * [Removing repositories](#removing-repositories)
+  * [Updating repositories](#updating-repositories)
   * [Notes on repository and problem names](#notes-on-repository-and-problem-names)
     + [Problem query](#problem-query)
     + [Name rules](#name-rules)
 - [How to Add Soma Support to Your Repository](#how-to-add-soma-support-to-your-repository)
-  * [`soma.toml` syntax](#-somatoml--syntax)
+  * [`soma.toml` syntax](#somatoml-syntax)
     + [The root section](#the-root-section)
-      - [The `name` field](#the--name--field)
-      - [The `work_dir` field (optional)](#the--work-dir--field--optional-)
-    + [The `[binary]` section](#the---binary---section)
-      - [The `os` field](#the--os--field)
-      - [The `cmd` field](#the--cmd--field)
+      - [The `name` field](#the-name-field)
+      - [The `work_dir` field (optional)](#the-work_dir-field-optional)
+    + [The `[binary]` section](#the-binary-section)
+      - [The `os` field](#the-os-field)
+      - [The `cmd` field](#the-cmd-field)
       - [File entries](#file-entries)
-        * [The `path` field](#the--path--field)
-        * [The `target_path` field (optional)](#the--target-path--field--optional-)
-        * [The `public` field (optional)](#the--public--field--optional-)
+        * [The `path` field](#the-path-field)
+        * [The `target_path` field (optional)](#the-target_path-field-optional)
+        * [The `public` field (optional)](#the-public-field-optional)
     + [Other subconfigurations](#other-subconfigurations)
-  * [`soma-list.toml` syntax](#-soma-listtoml--syntax)
-    + [The `problems` field](#the--problems--field)
+  * [`soma-list.toml` syntax](#soma-listtoml-syntax)
+    + [The `problems` field](#the-problems-field)
 - [Development](#development)
   * [Prerequisites](#prerequisites)
-  * [Testing, Building, and Running](#testing--building--and-running)
+  * [Testing, Building, and Running](#testing-building-and-running)
 - [License](#license)
   * [Contribution](#contribution)
 
@@ -140,13 +141,14 @@ We are expecting to release `0.1.0-alpha` soon to [crates.io].
 
 ### Command overview
 
-
 |          | Add / Create | Remove |
 | -------- | ------------ | ------ |
 | Repository | [add](#adding-repositories) | [remove](#removing-repositories) |
 | Image | [build](#building-problem-images) | [clean](#removing-problem-images) |
 | Container | [run](#running-problems) | [stop](#stopping-problems) |
 
+Additionally, [update](#updating-repositories)
+
 
 ### Adding repositories
 
@@ -249,6 +251,17 @@ $ soma remove soma-bata-list
 There should be no problem image or container associated to the repository when you use this command. Use `clean` and `stop` command to remove them if necessary. Auto pruning for your convenience will be implemented in the future (see [#115][issue #115]).
 
 
+### Updating repositories
+
+You can update and sync repositories with `update` command:
+
+```bash
+$ soma update soma-bata-list
+```
+
+Note that problem containers that are already running are untouched by this command. You might want to stop, build, and run the problem again after updating a repository.
+
+
 ### Notes on repository and problem names
 
 #### Problem query

src/bin/soma/commands.rs

@@ -8,6 +8,7 @@ use soma::{Environment, Printer};
 pub use self::{
     add::AddCommand, build::BuildCommand, clean::CleanCommand, fetch::FetchCommand,
     list::ListCommand, remove::RemoveCommand, run::RunCommand, stop::StopCommand,
+    update::UpdateCommand,
 };
 
 pub mod add;
@@ -18,6 +19,7 @@ pub mod list;
 pub mod remove;
 pub mod run;
 pub mod stop;
+pub mod update;
 
 type App = clap::App<'static, 'static>;
 

src/bin/soma/commands/update.rs

@@ -0,0 +1,43 @@
+use clap::{Arg, ArgMatches, SubCommand};
+use hyper::client::connect::Connect;
+
+use soma::ops::update;
+use soma::prelude::*;
+use soma::{Environment, Printer};
+
+use crate::commands::{default_runtime, App, SomaCommand};
+
+pub struct UpdateCommand;
+
+impl UpdateCommand {
+    pub fn new() -> UpdateCommand {
+        UpdateCommand {}
+    }
+}
+
+impl SomaCommand for UpdateCommand {
+    const NAME: &'static str = "update";
+
+    fn app(&self) -> App {
+        // TODO: update all repository when repository is omitted
+        SubCommand::with_name(Self::NAME)
+            .about("Updates a repository")
+            .arg(
+                Arg::with_name("repository")
+                    .required(true)
+                    .help("the name of the repository to update"),
+            )
+    }
+
+    fn handle_match(
+        &self,
+        env: Environment<impl Connect, impl Printer>,
+        matches: &ArgMatches,
+    ) -> SomaResult<()> {
+        update(
+            &env,
+            matches.value_of("repository").unwrap(),
+            &mut default_runtime(),
+        )
+    }
+}

src/bin/soma/main.rs

@@ -33,6 +33,7 @@ fn main_result() -> SomaResult<()> {
     let remove_command = RemoveCommand::new();
     let run_command = RunCommand::new();
     let stop_command = StopCommand::new();
+    let update_command = UpdateCommand::new();
 
     let matches = App::new("soma")
         .version(VERSION)
@@ -46,6 +47,7 @@ fn main_result() -> SomaResult<()> {
         .subcommand(remove_command.app())
         .subcommand(run_command.app())
         .subcommand(stop_command.app())
+        .subcommand(update_command.app())
         .get_matches();
 
     let mut data_dir = DataDirectory::new()?;
@@ -60,6 +62,7 @@ fn main_result() -> SomaResult<()> {
         (RemoveCommand::NAME, Some(matches)) => remove_command.handle_match(env, matches),
         (RunCommand::NAME, Some(matches)) => run_command.handle_match(env, matches),
         (StopCommand::NAME, Some(matches)) => stop_command.handle_match(env, matches),
+        (UpdateCommand::NAME, Some(matches)) => update_command.handle_match(env, matches),
         _ => unreachable!(),
     }
 }

src/docker.rs

@@ -138,6 +138,16 @@ pub fn image_from_prob_exists(images: &[SomaImage], problem: &Problem) -> bool {
     })
 }
 
+pub fn image_from_repo_and_prob_exists(
+    images: &[SomaImage],
+    repo_name: &str,
+    prob_name: &str,
+) -> bool {
+    images
+        .iter()
+        .any(|image| image.repo_name() == repo_name && image.prob_name() == prob_name)
+}
+
 #[derive(Debug)]
 pub struct SomaContainer {
     repo_name: String,

src/error.rs

@@ -40,6 +40,10 @@ pub enum Error {
     RepositoryInUse,
     #[fail(display = "The specified repository is not found")]
     RepositoryNotFound,
+    #[fail(
+        display = "The repository contains changes that cannot be handled by update command; Please remove and add the repository manually"
+    )]
+    UnsupportedUpdate,
 }
 
 pub type Result<T> = std::result::Result<T, failure::Error>;

src/ops.rs

@@ -31,8 +31,8 @@ pub fn add(
 
     env.repo_manager_mut().add_repo(repo_name, backend)?;
 
-    let repository = env.repo_manager().get_repo(repo_name)?;
-    repository.update()?;
+    let mut repository = env.repo_manager().get_repo(repo_name)?;
+    repository.update(&[])?;
 
     env.printer()
         .write_line(&format!("Repository added: '{}'", repo_name));
@@ -68,12 +68,6 @@ pub fn build(
     runtime: &mut Runtime,
 ) -> SomaResult<()> {
     let problem = env.repo_manager().search_prob(prob_query)?;
-    let repo_name = problem.repo_name();
-
-    let repository = env.repo_manager().get_repo(repo_name).unwrap();
-    repository.update()?;
-    env.printer()
-        .write_line(&format!("Repository updated: '{}'", repo_name));
 
     runtime.block_on(docker::prune_images_from_prob(&env, &problem))?;
     build_image(&env, &problem, runtime)?;
@@ -269,3 +263,16 @@ pub fn stop(
 
     Ok(())
 }
+
+pub fn update(
+    env: &Environment<impl Connect, impl Printer>,
+    repo_name: &str,
+    runtime: &mut Runtime,
+) -> SomaResult<()> {
+    let mut repository = env.repo_manager().get_repo(repo_name)?;
+    repository.update(&runtime.block_on(docker::list_images(env))?)?;
+    env.printer()
+        .write_line(&format!("Repository updated: '{}'", repo_name));
+
+    Ok(())
+}

src/repository.rs

@@ -3,6 +3,7 @@ use std::path::{Path, PathBuf};
 
 use serde::{Deserialize, Serialize};
 
+use crate::docker::{self, SomaImage};
 use crate::prelude::*;
 use crate::problem::{read_manifest, MANIFEST_FILE_NAME};
 use crate::repository::backend::{Backend, BackendExt};
@@ -37,7 +38,7 @@ impl ProblemList {
     }
 }
 
-#[derive(Clone, Deserialize, Serialize)]
+#[derive(Clone, Deserialize, Serialize, PartialEq, Eq, Hash)]
 struct ProblemIndex {
     name: NameString,
     path: PathBuf,
@@ -81,8 +82,39 @@ impl<'a> Repository<'a> {
         self.manager.repo_path(&self.name)
     }
 
-    pub fn update(&self) -> SomaResult<()> {
-        self.backend.update_at(self.path())
+    pub fn update(&mut self, images: &[SomaImage]) -> SomaResult<()> {
+        let current_prob_set: HashSet<_> = self
+            .prob_list
+            .clone()
+            .into_iter()
+            .map(|prob_index| prob_index.name)
+            .collect();
+        let new_prob_list = {
+            let temp_dir = tempfile::tempdir()?;
+            self.backend().update_at(temp_dir.path())?;
+            read_prob_list(temp_dir.path())?
+        };
+        let new_prob_set: HashSet<_> = new_prob_list
+            .clone()
+            .into_iter()
+            .map(|prob_index| prob_index.name)
+            .collect();
+
+        let existing_problem_removed = current_prob_set
+            .difference(&new_prob_set)
+            .filter(|prob_name| {
+                docker::image_from_repo_and_prob_exists(images, &self.name, prob_name)
+            })
+            .count()
+            > 0;
+
+        if existing_problem_removed {
+            Err(SomaError::UnsupportedUpdate)?;
+        }
+
+        self.backend.update_at(self.path())?;
+        self.prob_list = new_prob_list;
+        Ok(())
     }
 
     pub fn prob_name_iter(&'a self) -> impl Iterator<Item = &'a NameString> {

src/repository/backend.rs

@@ -1,9 +1,9 @@
 use std::fmt::{self, Display};
-use std::fs::remove_dir_all;
 use std::path::{Path, PathBuf};
 
 use fs_extra::dir;
 use git2::{BranchType, ObjectType, Repository as GitRepository, ResetType};
+use remove_dir_all::remove_dir_all;
 use serde::{Deserialize, Serialize};
 use url::Url;
 

templates/binary/Dockerfile

@@ -2,10 +2,11 @@ FROM {{ binary.os }}
 
 RUN apt-get -qq update && apt-get -yqq upgrade && apt-get install -yqq socat
 
+COPY image-root/ /
+
 ENV PROB "{{ name }}"
 RUN useradd -m $PROB
 
-COPY image-root/ /
 COPY .soma/ /.soma
 
 RUN chmod 555 /.soma/configure_permissions.sh \