Każdy z Was spotkał się kiedyś na pewno, z problemem przygotowania aplikacji do deployu (umieszczenia na serwerze). Lista rzeczy które trzeba zrobić nie jest duża, ale obejmuje m.in.:

  • Wyczyszczenie cachey, tempów i innych nie potrzebnych plików
  • Usunięcie katalogów repozytoriów (czy to git czy też svn)
  • Usunięcie testów
  • Usunięcie innych plików związanych ze środowiskiem developerskim bądź testowym
  • Ew. “zaciemnienie” kodu

Mówiąc “zaciemnianie” nie mam na myśli stricte obfuscacji. Railsy są środowiskiem gdzie wszystko ma być (i jest) czytelne i przejrzyste. Jednak każdemu z nas (mi na szczęście niezmiernie rzadko) trafiają się klienci którzy chcą mieć aplikacje u siebie.

O ile problem przeniesienia kodu dalej (czyli wyciek) można ograniczyć przy pomocy dobrze napisanej umowy licencyjnej, o tyle “zabaw” z kodem – w wykonaniu klienta już raczej nie.

Dlatego wpadłem na pomysł że “zaśmiecę” kod aplikacji, dużą ilością komentarzy które albo będą wygenerowanymi losowo ciągami znaków, albo kawałkami kodu z innych fragmentów aplikacji. W ten sposób – trzeba będzie się przedrzeć przez gąszcz komentarzy i chaosu aby coś nabrudzić.

Oczywiście nie zabezpieczy to kodu przed osobami które chcą, jednak większość “grzebaczy” widząc takie rzeczy po prostu zrezygnuje z dalszego kombinowania.

Aby uprościć sobie życie, napisałem krótki (300 linijek) skrypt który przygotowuje “minimalistyczną” wersję kodu, na potrzeby wrzucenia na produkcję. Poniżej pokażę Wam jak stworzyć swoją wersję takiego pliku.

Pierwszą rzeczą jaką zrobimy, jest dołączenie do naszego pliku deploy.rb odpowiednich dowiązań. Potrzebujemy biblioteki find do wylistowania plików oraz biblioteki fileutils aby coś z tymi plikami zrobić. Tak więc:

# coding: utf-8
require 'find'
require 'fileutils'

# Skrypt automatyzujący deployment aplikacji
# Usuwa sensowne komentarze, robi taki bałagan w kodzie ;)
# Usuwa to czego klientowi na produkcji nie potrzeba
# Sprzata, czysci i pozostawia absolutne minimum

Dodaliśmy także “magiczny” komentarz mówiący że być może będziemy korzystać z utf-8. Jest to ważne dla Rubiego 1.9.2 i wzwyż. Dodaliśmy także komentarz co nasz skrypt robi.

Mając to minimum, teraz musimy zdefiniować w postaci stałych, co ma być zaciemnione, co usunięte, itp.
Najprościej, tak jak wspomniałem, jest zrobić to w stałych. Zdefiniujmy sobie listę katalogów, z których pliki mają zostać “zaciemnione”:

# Które katalogi ma "zaciemniać"
MASK_DIRS = [
  './deploy/app/models',
  './deploy/app/controllers/',
  './deploy/app/mailers/',
  './deploy/db/',
  './deploy/lib/',
  ]

Które katalogi ma usunąć:

# Które katalogi i pliki mają zostać usunięte (ktore nie są potrzebne klientowi)
# Przy okazji usuwa wszystkie katalogi i pliki takie jak temp, cache, .svn
CLEAR_ELEMENTS = [
  './deploy/config/environments/development.rb',
  './deploy/config/environments/test.rb',
  './deploy/db/migrate',
  './deploy/doc',
  './deploy/log',
  './deploy/nbproject',
  './deploy/test',
  './deploy/README',
  './deploy/deploy.rb'
]

I ostatnie, wyrażenia regularne. Niezależnie gdzie dany katalog się znajduje, jeśli będzie zgodny ze wzorcem, to zostanie usunięty:

# Nazwy katalogów i plików tymczasowych które mają zostać usunięte
CLEAR_REGS = [
  'temp',
  'tmp',
  'cache',
  '.svn',
  '.git'
]

Zanim przejdziemy dalej, musimy wyjaśnić sobie jedną rzecz. Czym jest subkatalog “deploy” który przewija się w ścieżkach? Otóż jak zobaczycie dalej, nasz skrypt będzie odpalany z głównego katalogu naszej aplikacji. Jednak aby niczego nie zepsuć czy nie usunąć przez przypadek, do celów deployu wykonamy sobie kopię całego systemu, która trafi właśnie do subkatalogu “deploy/”. To właśnie na tej kopii będziemy wykonywać operacje zaciemniania oraz usuwania. Dzięki temu w razie wybrania złych katalogów do usunięcia (załóżmy katalogu lib), nie stracimy ważnych kodów źródłowych.

Warto tutaj wspomnieć że o ile będziemy sterować maskowaniem i usuwaniem plików, o tyle oryginalne komentarze zostaną usunięte z każdego pliku z rozszerzeniem rb.

Zajmijmy się więc naszym “backuperem”. Jego zadaniem będzie zrobienie kopii całego systemu do katalogu “deploy/”. Jeśli taki katalog istniał, zostanie on usunięty a na jego miejsce zostanie przekopiowana aktualna wersja systemu.

  # Robi kopię "deploymentową" do katalogu /deploy/ w aplikacji
  class Backuper
    def self.run
      deploy = './deploy/'
      if File.directory?(deploy)
        puts "Removing old deployment..."
        FileUtils.rm_rf(deploy)
      end

      files = Dir.glob('*')
      FileUtils.mkdir 'deploy'
      puts "Creating new deployment..."
      FileUtils.cp_r files, 'deploy'
    end
  end

Tutaj za bardzo nie ma co tłumaczyć. Sprawdzamy czy istniał katalog, jeśli tak to go usuwamy. Następnie pobieramy listę plików i katalogów naszego systemu i kopiujemy go do deploy/.

Proste, skuteczne i szybkie :)

Kolejnym modelem jakiego potrzebujemy, jest “cleaner”. Model usuwający wszystkie pliki które są dla nas, nie dla klienta. Działa on dwuetapowo. Pierwszym etapem jest usunięcie plików “regularnych”, czyli tych z CLEAR_ELEMENTS. Robi się to bardzo prosto. Jeśli ścieżka jest katalogiem, to usuń katalog. Jeśli to plik, usuń plik:

      # Najpierw usuń "stałe" elementy
      CLEAR_ELEMENTS.each{ |e|
        # Jeśli to katalog to go usun
        if File.directory?(e)
          puts "Removing: #{e}"
          FileUtils.rm_rf(e)
        end
        # Jesli plik to tez usun ;)
        if File.exists?(e)
          puts "Removing: #{e}"
          File.delete(e)
        end
      }

Drugim etapem jest usunięcie regularnych. Tutaj po prostu porównujemy nazwę katalogu/pliku z nazwą zawartą w CLEAR_REGS. Jeśli pasują, to usuwamy. Dodatkowo “odtwarzaniu” podlegają katalogi “tmp”. Są one czyszczone, jednak sam katalog pozostaje. Zrobiłem tak dlatego że część moich testów wymaga by ten katalog istniał. Jeśli nie macie testów tego typu, możecie się bez tego obejść. Kod przeszukuje całą strukturę, katalog po katalogu, razem z subkatalogami.

      # Teraz elementy regexpowe, czyli jakies tam katalogi
      # ktore moga byc w roznych miejscach
      CLEAR_REGS.each{ |r|
        Find.find('./deploy/') { |f|
          name = f.split('/').last
          if name ==  r
            if File.directory?(f)
              puts "Recreating: #{f}"
              FileUtils.rm_rf(f)
	      # tmp odtwórz bo testy nie zostaną zakonczone pomyslnie (kwestia np resetu passengera w tmp)
              FileUtils.mkdir f if f.split('/').last == 'tmp'
            end
          end
        }
      }

Powyższy kod “obudujemy” w naszą klasę:

  # Usuwa to, czego klient nie potrzebuje
  class Cleaner
    def self.run
      # Najpierw usuń "stałe" elementy
      CLEAR_ELEMENTS.each{ |e|
        # Jeśli to katalog to go usun
        if File.directory?(e)
          puts "Removing: #{e}"
          FileUtils.rm_rf(e)
        end
        # Jesli plik to tez usun ;)
        if File.exists?(e)
          puts "Removing: #{e}"
          File.delete(e)
        end
      }

      # Teraz elementy regexpowe, czyli jakies tam katalogi
      # ktore moga byc w roznych miejscach
      CLEAR_REGS.each{ |r|
        Find.find('./deploy/') { |f|
          name = f.split('/').last
          if name ==  r
            if File.directory?(f)
              puts "Recreating: #{f}"
              FileUtils.rm_rf(f)
	      # tmp odtwórz bo testy nie zostaną zakonczone pomyslnie (kwestia np resetu passengera w tmp)
              FileUtils.mkdir f if f.split('/').last == 'tmp'
            end
          end
        }
      }
    end
  end

Tyle w części pierwszej. W części drugiej zajmiemy się stworzeniem “śmieciarza” który będzie nam “brudził” nasze pliki. Nasz skrypt już spisuje się całkiem nieźle:

  • Wykonuje kopię naszego projektu
  • Usuwa wszystkie niepotrzebne pliki

Tutaj możesz zobaczyć pozostałe części tutoriala: