Code driven development w Drupalu 7 | DrupalCamp Wrocław 2014

Code-Driven Development (CDD) w Drupalu 7
Grzegorz Bartman www.droptica.com
Twitter: @grzegorzbartman

●
2008 – pierwsze strony na Drupalu (wersja 6.x i 5.x)
●
2009 – pierwsze próby z Code Driven Development w Drupalu (Drupal 6, Views export,
Content type export)
●
2010 – pierwsze próby z Continuous Integration w Drupalu (Hudson CI)
●
2014 – ~40 projektów rozwijanych w Droptica przy zastosowaniu Code Driven
Development i Continuous Integration (Jenkins CI)
Grzegorz Bartman
http://twitter.com/grzegorzbartman
https://drupal.org/user/363120 ponad 5 lat na drupal.org, 9 projektów, 61 commitów
O mnie

Dlaczego code
driven development?

Ścieżka rozwoju Drupalowca (1)
(na moim przykładzie)

●
Proste strony, najczęściej małe strony
firmowe z aktualnościami, stronami
statycznymi.
●
Kilka prostych rodzajów zawartości.
●
1 redaktor treści,
●
1 osoba rozwijająca serwis.

●
Bardziej złożony projekt.
●
Oczekiwany czas realizacji uniemożliwia wykonanie
projektu przez 1 osobę.
●
2-3 osoby pracują nad jednym projektem.
●
Jak radzić sobie w pracy w zespole nad nowym
projektem?
●
Jak radzić sobie w pracy w zespole nad już
działającym projektem?

● Pierwsze próby rozwiązania problemu
wspólnej pracy nad projektem w Drupalu
– Praca nad wspólnymi plikami i jedną bazą danych
na zdalnym serwerze, edycja plików przez FTP
– Każdy ma osobne pliki (repozytorium) ale
współdzielimy ze sobą bazę danych (wymieniamy
plik ze zrzutem bazy danych) , w której trzymamy
ustawienia (strukturę serwisu)

●
Kilkadziesiąt projektów rozwijanych przez
kilku/kilkunastu developerów w firmie.
– Jak tworzyć projekty aby każda osoba z zespołu
mogła szybko wdrożyć się w nowy projekt?
Standaryzacja projektów.
– Jak sprawnie wdrażać zmiany na wersję
produkcyjną?

Złożoność projektów w Droptica
Liczba tabel w bazie danych 601 1331 229 349 371
Rozmiar bazy danych (MB) 477 1421 - 623 2047
Ilość rodzajów zawartości 41 40 10 22 24
Ilość pól 206 349 71 88 79
Ilość widoków 70 69 41 102 51
Ilość włączonych modułów (tabela system) 204 202 109 231 204
Ilość dedykowanych modułów napisanych
na potrzeby aplikacji
44 34 33 39 46

Co to jest Code Driven
Development?
●
Zapisywanie ustawień Drupala w plikach
●
Wprowadzanie zmian w ustawieniach Drupala za
pomocą kodu PHP

Kiedy nie warto stosować CDD?
●
Małe serwisy internetowe, które są tworzone przez jedną
osobę i nie są rozwijane po wdrożeniu na serwer produkcyjny
●
W pierwszej fazie budowy serwisu internetowego, kiedy
pracuje nad nim tylko 1 osoba
●
Przy modyfikacji serwisu internetowego, który już działa na
produkcji ale w czasie wykonywania modyfikacji (lokalnie, na
kopii) mamy pewność, że nie zmieni się baza danych na
produkcji.

Jak stosować CDD?
Baza danych
Dev
Pliki PHP
Zapis ustawień
z bazy danych
do plików
Pliki PHP
Baza danych
Produkcja
Wczytanie
ustawień
do bazy danychPrzeniesienie
plików z wersji
dev na produkcję

Dev
Developer 1
Przepływ plików PHP
Developer 2 GIT
Developer 3
Staging
Production

Dev
Developer 1
Przepływ bazy danych i plików drupalowych
(sites/default/files)
Developer 2
Developer 3
Staging
Production

Narzędzia wspomagające CDD
●
Własna konfiguracja:
– Repozytorium GIT
– Skrypt budujący (bash + drush)
– Jenkins CI
– Aegir
●
Acquia Dev Cloud
●
Pantheon

GIT flow
●
http://www.droptica.pl/video/git-flow-droptica-drupal-hangout
●
https://github.com/nvie/gitflow

Eksport ustawień (1)
Tworzenie struktury danych
(rodzaje zawartości, pola)
Tworzenie prezentacji danych
(views, context, panels, display suite,..)
Tworzenie akcji przy określonych zdarzeniach
(rules)
DEV
Produkcja
W jaki sposób przenieść
zmiany na serwer produkcyjny?

●
Moduł Features https://drupal.org/project/features (w Drupal
8 moduł Configuration Manager
https://drupal.org/documentation/administer/config )
●
Kody strony drupalcampwroclaw.pl
https://github.com/DrupalCampWroclaw/website
●
Strona testowa budowana przez Jenkinsa
http://www.websitedev.dev.drupalcampwroclaw.pl/
●
Jenkins http://dev.drupalcampwroclaw.pl:8080/

● W modułach wyeksportowanych przez Features możemy dopisywać własny kod
● Kod nie zostanie usunięty przy operacji „Recreate”

Status „Overriden” informuje nas o różnicach pomiędzy ustawieniami w bazie danych i w plikach

Po zainstalowaniu modułu Diff (https://drupal.org/project/diff) możemy zobaczyć zmiany

● Wczytanie zmian z plików do Drupala wykonujemy za pomocą „Revert components”
● Zapisanie nowych zmian do modułu wykonujemy za pomocą „Recreate”

Features – kolejność operacji (1)
Tworzenie rodzaju zawartości
Eksport do nowego modułu feature
[Create Feature]
Przesłanie modułu na produkcję
Włączenie modułu na produkcji

Features – kolejność operacji (2)
Zmiany w rodzaju zawartości
np. dodanie nowego pola
Aktualizacja wyeksportowanych danych
w module feature
[Recreate]
Przesłanie modułu na produkcję
Wczytanie nowych ustawień na produkcji
[Revert components]

Jak dzielić komponenty w Features (1)
●
Można wszystkie komponenty (rodzaje zawartości, widoki,
zmienne, konteksty, itd.) wyeksportować do jednego dużego
modułu
●
Łatwiej i szybciej utworzyć taki moduł jednak odradzam takie
rozwiązanie m.in.. z następujących powodów:
– Konflikty w repozytorium plików jeśli nad projektem
pracuje zespół programistów
– Brak możliwości ponownego użycia w innych projektach

●
Utworzenie głównego modułu dla projektu o nazwie
Application, Project, Master lub innej
●
Komponenty
– Zależne moduły (dependencies) – uniemożliwiamy ręczne
przypadkowe wyłączenie jednego z zależnych modułów
– Zmienne czyli ustawienia modułów specyficzne dla
naszego projektu (konieczny moduł Strongarm)
– Role i Uprawnienia specyficzne dla naszego projektu
– Ustawienia językowe
– Menu (ale nie odnośniki menu)

●
Moduł UserProfile
●
Komponenty
●
Pola przypisane do profilu użytkownika
●
Konteksty, panele, itp. związane z wyświetlaniem
profilu użytkownika lub stronami rejestracji i logowania
●
Widoki wyświetlane na profilu użytkownika lub na
stronach rejestracji i logowania

●
Moduł Layout
●
Komponenty
●
Bloki (boxes, beans) wyświetlane globalnie w serwisie
(np. w nagłówku lub stopce)
●
Kontekst aktywny w całym serwisie (sitewide context)
●
Style obrazków
●
Inne, niepasujące do pozostałych typów features
(należy uważać, żeby w tym module nie zrobił się za
duży śmietnik)
●
Widoki listujące jednocześnie wiele rodzajów
zawartości

●
Moduł dla danego rodzaju zawartości
●
Komponenty
●
Rodzaj zawartości
●
Pola
●
Zmienne związane z rodzajem zawartości (często
moduły tworzą zmienne dla każdego rodzaju
zawartości)
●
Widoki listujące dany rodzaj zawartości
●
Konteksty, panele, bloki,

Problemy z Features
●
Konflikty – gdy do dwóch features zostanie
wyeksportowany ten sam komponent.
– Tworzymy jednocześnie tylko jeden feature, po każdym
utworzeniu odświeżamy stronę z listą features
– Można edytować plik i ręcznie usunąć z jednego modułu
powtarzający się komponent (z pliku .info i
odpowiedniego pliku .inc)
●
Menu links – często pomimo odtwarzania (recreate) moduły
z takim komponentem cały czas ma status nadpisany
(overriden).
●
Nie wszystkie moduły pozwalają na eksport swoich
ustawień.

Profil instalacyjny
●
Tworzymy katalog [nazwaprofilu] w /profiles
●
Tworzymy pliki .info, .install i .profile w /profiles/
[nazwaprofilu]
●
W pliku .info dodajemy zależność do głównego modułu
●
dependencies[] = application
name = DrupalCamp Wroclaw
description = DrupalCamp Wroclaw installation profile.
core = 7.x
dependencies[] = application
version = "7.x-1.0-beta1"

hook_install i hook_update_N
●
hook_install – tu umieszczamy kody jeśli tworzymy profil
instalacyjny, np. application_install w pliku application.install
●
hook_update_N – tu umieszczamy kody jeśli aktualizujemy
aplikację, gdzie N jest kolejnym numerem
– Drupal pamięta, który numer aktualizacji był już wykonany
i nie będzie go wykonywał więcej niż jeden raz
– Zaleca się numer aktualizacji powiązać z numerem wersji
modułu, np.:
●
Wersja modułu 7.x-1.0-beta28
●
application_update_7028()

Testowanie kodów w
hook_update_N
●
Użyj modułu Devel i strony /devel/php aby przetestować
fragmenty kodu wstawiane w hook_update_N lub
hook_install

Najczęściej wykonywane operacje
w hook_update_N lub hook_install
●
Dodawanie lub edycja treści
●
Dodawanie lub edycja termów taxonomy
●
Dodawanie lub edycja użytkowników
●
Dodawanie lub edycja menu i odnośników menu
●
Zapisywanie zmiennych
●
Nowe formaty daty
●
Operacje na tabelach w bazie danych
●
Włączanie i wyłączanie modułów
●
Przywracanie Features
●
Dodawanie tłumaczeń z plików .po
●
Dodawanie aliasów URL

Operacje na treści (1)
●
Włączenie komentarzy do istniejących wpisów
function application_update_7023() {
$nodes = node_load_multiple(array(), array('type' => 'session'));
foreach ($nodes as $node) {
$node->comment = COMMENT_NODE_OPEN;
node_save($node);
}
}

●
Dodanie nowej treści
$node = new stdClass;
$node->type = 'page';
node_object_prepare($node);
$node->title = 'Drupal';
$node->language = 'en';
$node->uid = 1;
$node->body[LANGUAGE_NONE][0]['value'] = 'Lorem ipsum';
$node->body[LANGUAGE_NONE]['summary'] = NULL;
$node->body[LANGUAGE_NONE][0]['format'] = 'full_html';
node_submit($node);
node_save($node);

●
Budowa obiektu node

●
Aktualizacja treści
$node = node_load(18);
$node->body[LANGUAGE_NONE][0]['value'] = 'Nowy tekst'
node_save($node);

●
Dodanie treści z polem ze zdjęciem
$node = new stdClass;
$node->type = 'page';
node_object_prepare($node);
$node->body[LANGUAGE_NONE][0]['value'] = 'Lorem ipsum';
$fname = '1.jpg'
$file_temp = file_get_contents($path . $fname);
$file_temp = file_save_data($file_temp, 'public://'.$fname, FILE_EXISTS_RENAME)
$node->field_image[LANGUAGE_NONE][0] = (array)$file_temp;
node_submit($node);
node_save($node);

Operacje na taxonomy (1)
●
Dodawanie nowego terma
$term = new stdClass();
$term->name = 'Red';
$term->parent = 0;
$term->vid = 2; //Vocabulary ID
$term->field_example[LANGUAGE_NONE][0]['value'] = 'test';
taxonomy_term_save($term);
dpm($term);

Operacje na taxonomy (2)
●
Zmiana terma
$term = taxonomy_term_load(122);
$term->name = 'Blue';
taxonomy_term_save($term);

Operacje na użytkownikach (1)
●
Dodwanie nowego użytkownika
$new_user = array(
'name' => 'user1@droptica.com',
'pass' => 'password',
'mail' => 'user1@droptica.com',
'init' => 'user1@droptica.com',
'status' => 1,
);
user_save(NULL, $new_user);

Operacje na użytkownikach (2)
●
Zmiana danych użytkownika
$user = user_load(1);
$user->name = 'root';
user_save($user);

Operacje na menu (1)
●
Dodawanie nowego menu
$menu = array(
'menu_name' => 'header-top-menu', // Drupal menu machine name
'title' => 'Header top menu', // Drupal menu display name
'description' => 'Header top menu', // Optional menu description
);
menu_save($menu);

Operacje na menu (2)
●
Dodawanie odnośnika do menu
$item = array(
'link_path' => 'node/' . $node->nid,
'link_title' => $node->title,
'menu_name' => 'main-menu',
'weight' => 10,
'plid' => $plid,
'module' => 'menu',
);
menu_link_save($item);

Operacje zmiennych (1)
●
Zapisywanie zmiennych
variable_set('user_picture_style', '130x130');
variable_set('theme_default', 'dtheme');
variable_set('date_default_timezone', 'Europe/Berlin');
variable_set('site_frontpage', 'main');

Operacje formatach daty (1)
●
Zapisywanie nowych formatów daty
db_query("INSERT INTO date_formats(format, type, locked)
VALUES ('Y-m-d', 'custom', 0); ");
db_query("INSERT INTO date_formats(format, type, locked)
VALUES ('H:i', 'custom', 0); ");
db_query("INSERT INTO date_format_type(type, title, locked)
VALUES ('date_ymd', 'date_ymd', 0); ");
db_query("INSERT INTO date_format_type(type, title, locked)
VALUES ('date_hi', 'date_hi', 0); ");
variable_set('date_format_date_hi', 'H:i');
variable_set('date_format_date_ymd', 'Y-m-d');

Operacje na bazie danych (1)
●
Wyłączenie wszystkich bloków
$query = "UPDATE {block} SET region = '-1';";
db_query($query);

●
Ustawienie języka dla wszystkich komentarzy
// Set comments language to UND.
db_update('comment')
->fields(array('language' => 'und'))
->execute();

●
Dodawanie ustawień dla modułu spamicide
db_insert('spamicide')
->fields(array(
'form_id' => $spamicide_form_id,
'form_field' => 'specialfield_' . rand(10000, 100000),
'enabled' => 1,
))
->execute();

●
Dodawanie lub aktualizowanie rekordu do własnej tabeli w
bazie danych
$row = new stdClass();
$row->order_id = $order_id;
$row->uid = $order->uid;
$row->coupon_updated = REQUEST_TIME;
$row->tid = $term_tid;
$row->coupon_code = $form_coupon_code;
$row->coupon_uses = 0;
drupal_write_record('commerce_app_coupon_usage', $row);
drupal_write_record('commerce_app_coupon_usage', $row, array('order_id'))

Operacje na modułach (1)
●
Włączenie modułu
// Enable modules.
$module_list = array(
'comment',
);
module_enable($module_list);
module_list(TRUE, FALSE);
// Flush caches.
drupal_flush_all_caches();

Operacje na modułach (2)
●
Wyłączenie modułu
// Disable modules.
$module_list = array(
'overlay',
);
module_disable($module_list);
module_list(TRUE, FALSE);
// Flush caches.
drupal_flush_all_caches();

Operacje na Features (1)
●
Przywracanie features
function application_api_features_revert($modules) {
module_load_include('inc', 'features', 'features.export');
features_include();
foreach ($modules as $module) {
if (($feature = feature_load($module, TRUE)) && module_exists($module)) {
$components = array();
// Forcefully revert all components of a feature.
foreach (array_keys($feature->info['features']) as $component) {
if (features_hook($component, 'features_revert')) {
$components[] = $component;
}
}
}
foreach ($components as $component) {
features_revert(array($module => array($component)));
}
}
}
…
application_api_features_revert(array('application', 'news'));

Tłumaczenia
●
Ładowanie wszystkich tłumaczeń z plików .po z sites/all
include_once './includes/locale.inc';
$lang_code = 'pl';
// Load translations.
$files = file_scan_directory('sites/all', '/' . $lang_code . '.po/');
foreach ($files as $file) {
$file->filepath = $file->filename;
_locale_import_po($file, $lang_code, LOCALE_IMPORT_KEEP, 'default');
}

Alias URL
●
Dodanie aliasu URL
// Url aliases.
$path = array(
'source' => 'user/register',
'alias' => 'rejestracja',
'language' => 'pl'
);
path_save($path);

Problemy
w hook_update_N lub hook_install
●
Chcemy wykonać funkcję z modułu, który nie jest jeszcze
włączony
●
Chcemy operować na polach, które nie zostały jeszcze
załadowane do Drupala z nowych features

Układ katalogów modułów
●
sites/all/modules
– contrib – moduły z drupal.org
– custom – moduły dedykowane dla konkretnego projektu
– universal – moduły własne przenośne między projektami
– dev – moduły potrzebne tylko na czas prac
programistycznych

Układ katalogów aplikacji
●
app – Drupal
●
conf – pliki konfiguracyjne
●
scripts – skrypty instalacyjne
●
databases – zrzuty baz danych (zalecamy dodać do .gitignore)
●
files – spakowane pliki z sites/default/files (zalecamy dodać
do .gitignore)
●
patches – zmiany w rdzeniu drupala lub w modułach z
drupal.org
●
docs – pliki z dokumentacją

Skrypt build.sh
Wczytanie pliku konfiguracyjnego
Instalacja serwisu
z profilu instalacyjnego
Wyczyszczenie bazy danych
Import zrzutu bazy danych
Uruchomienie aktualizacji
hook_update_N
Opcjonalnie inne operacje

Materiały w sieci
● http://www.droptica.pl/video/automatyzacja-tworzenia-stron-w-drupalu-na-przykladzie-strony-wwwdrupalcampwroclawpl
● http://2013.drupalcampwroclaw.pl/sesje/automatyzacja-w-tworzeniu-aplikacji-opartych-o-drupala-drush-jenkins-ci-phpunit/
● http://drupalcity.de/session/streamline-your-development-workflow-3-tier-environment
● http://dropbucket.org/
● Google: how to … programmaticaly in drupal

Code driven development w Drupalu 7 | DrupalCamp Wrocław 2014

More Related Content

What's hot (10)

Similar to Code driven development w Drupalu 7 | DrupalCamp Wrocław 2014 (20)

More from Grzegorz Bartman (9)

Code driven development w Drupalu 7 | DrupalCamp Wrocław 2014